elastic-enterprise-search 8.0.0.pre → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934f9963f52322f3ebfe4d938047fda1ab1bde21295bc48e9ff395fd04552b63
-  data.tar.gz: 93ee0ede64ccefd718b271ff50b179c2bf47cb531b5a9a09dd4ac9a06d32b803
+  metadata.gz: fe3de694901dc1b16bef977ae8e1c5fbe17da770daa14cf59fbbe3c46588331a
+  data.tar.gz: ca7d3672c8d91810d5ae0589f444ebc3992b7cb4673729b7c45e1e3184a43555
 SHA512:
-  metadata.gz: e762a601ada260c8a919af6bb65de7c48142200c585b55bf017e411272a3b653a9bb102ee79573eb3912aee96ea7511be4d51ad031ddb5112ad33e5ce396aca4
-  data.tar.gz: f8c8e04a2b3945a5e93f372beebd466ab4012625d0eea98132c2b2b89295e8bc3b84e99cfb1b0ec919b437b3244b2a7de9dcdca6149887940eb81c190d592514
+  metadata.gz: 580b81ecdca1b5e7522b3a5b54e237b29bccad3d99b93af9161c0f54196e4960436208b463f7dd6b416faef68e048c4c1b7bb4efe1429fcf7601184b0df35384
+  data.tar.gz: 05d5729c7254f93b0ca8b77a4400195b72854bf9973c2a499b23b90b2ecae8c20d82dc97fa68f2a05a7947305deab8d0578b92fc89b224a8c23395fdedfb0388

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

@@ -8,7 +8,7 @@ This document includes examples for different API requests. Please refer to the
 [source,rb]
 ----------------------------
 # Create an engine
-client.create_engine(name: 'videogames')
+client.create_engine(body: { name: 'videogames' })
 
 # List all engines
 client.list_engines
@@ -30,7 +30,7 @@ body = {
   type: 'meta',
   source_engines: [ 'books', 'videogames' ]
 }
-client.create_engine(name: engine_name, body: body)
+client.create_engine(body: body)
 
 # Add a source engine to a meta engine:
 client.add_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
@@ -184,13 +184,6 @@ client.delete_api_key(api_key_name: name)
 
 === Web Crawler
 
-[CAUTION]
-====
-The Elastic Enterprise Search web crawler 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.
-====
-
 See https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html[Web Crawler API reference] for more information.
 
 [source,rb]
@@ -202,6 +195,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)
@@ -308,6 +304,38 @@ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
 client.delete_crawler_active_crawl_request(engine_name)
 ----------------------------
 
+=== Adaptive Relevance Suggestions
+
+[source,rb]
+----------------------------
+# Update an adaptive relevance suggestion
+body = [{ query: 'forest', type: 'curation', status: 'applied' }]
+client.put_adaptive_relevance_suggestions(engine_name, body: body)
+
+# Retrieve an adaptive relevance suggestion
+client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
+
+# List adaptive relevance suggestions
+client.list_adaptive_relevance_suggestions(engine_name)
+----------------------------
+
+=== Adaptive Relevance Settings
+
+[source,rb]
+----------------------------
+# Show the settings for an engine
+client.adaptive_relevance_settings(engine_name)
+
+# Update relevance settings
+ body = {
+        curation: { enabled: true }
+      }
+client.put_adaptive_relevance_settings(engine_name, body: body)
+
+# Refresh adaptive relevance update process
+client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/release_notes/80.asciidoc

@@ -1,14 +1,117 @@
 [[release_notes_80]]
-=== 8.0.0.pre Release notes
+=== 8.0.0 Release notes
 
 [discrete]
 ==== General
 
-This is a pre-release for the upcoming `8.x` versions of the client.
+First release in the `8.x` branch of the client.
 
 - Tested with Elastic Enterprise Search API version 8.0-SNAPSHOT.
-- Tested with Ruby 2.7, 3.0, 3.1, JRuby 9.3.
-- Updates request to return an Elastic::API::Response object.
+- 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.
+- API: Updated endpoints that make a `GET` or `DELETE` requests to not have a `body`. Requests with `PUT` and `POST` now expect most parameters to be in the request body. Parameters that were available as both arguments and in the body are now just in the body.
+- API: An updated generator is being used to generate the endpoint code. The source code documentation has better typing hints for parameters.
 
-Full release notes will be released with 8.0.0 GA.
+[discrete]
+==== Response Object
+
+* Requests now return an `Elastic::API::Response` object. This behaves exactly the same as the previous response (`Elastic::Transport::Transport::Response`) but expands its functionality. With the previous response object, the body of the response had to be accessed calling the `body` method on the response. This new object behaves like the response.body Hash object, except when the `status` or `headers` are sent to it. This makes it easier to access the response data. Example:
+
++
+[source,rb]
+----------------------------
+client = Elastic::EnterpriseSearch::Client.new(
+  host: 'http://localhost:3002',
+  http_auth: {user: 'elastic', password: 'changeme'}
+)
+response = client.health
+response.class
+# => Elastic::API::Response
+response['version']['number']
+# => "8.1.4"
+response.body['version']['number']
+# => "8.1.4"
+response.status
+# => 200
+response.headers
+# =>
+{"date"=>"Tue, 10 May 2022 09:01:10 GMT",
+ "content-type"=>"application/json;charset=utf-8",
+ "etag"=>"W/\"etag--gzip\"",
+ "cache-control"=>"max-age=0, private, must-revalidate",
+ "x-request-id"=>"id",
+ "x-runtime"=>"0.023468",
+ "vary"=>"Accept-Encoding, User-Agent",
+ "content-length"=>"755",
+ "server"=>"Jetty(9.4.43.v20210629)"}
+----------------------------
+
+[discrete]
+==== App Search
+
+[discrete]
+===== API Changes
+
+- API Logs: Removes `date` parameters for filters. This API requires a nested date object under `filters` (now passed in via the body) containing `from` and `to` keys formatted in accordance with RFC3339. The App Search client provides the helper function `date_to_rfc3339` which receives a date String and converts it to the right format.
+- Crawler API : Internal Url updated from `v0` to `v1`. `create_crawler_crawl_rule` body is a required parameter (`order`, `policy`, `rule`, `pattern`). `create_crawler_entry_point` body is required (for `value`). `create_crawler_sitemap` body is required (for `url`). `put_crawler_crawl_rule` body is required (`order`, `policy`, `rule`, `pattern`). `put_crawler_crawl_schedule` body is required (`frequency`, `unit`). `put_crawler_entry_point` body is required (for `value`). `put_crawler_sitemap` body is required (`url`).
+- Curations API: parameters for `create_curation` and `put_curation` must be passed in inside the body parameter now. 
+- Engine APIs: `create_engine` removes the `name` parameter. It must be passed in inside the body parameter now.
+- Log Click: `log_clickthrough` now requires `body`, the parameter `query` and `document_id` are required.
+- Search: When using `search`, query can no longer be sent as an argument. The method will raise `ArgumentError` if no body is sent, since `query` is a required parameter in the body.
+- APIs where `body` has been removed since it's not used: `delete_engine`, `engine`, `list_engines`, `curation`, `delete_curation`, `schema`, `api_key`, `delete_api_key`, `list_api_keys`, `delete_synonym_set`, `list_synonym_set`, `synonym_set`, `list_documents`, `reset_search_settings`, `search_settings`, `crawler_active_crawl_request`, `crawler_crawl_request`, `crawler_crawl_schedule`, `crawler_domain`, `crawler_metrics`, `crawler_overview`, `crawler_process_crawl`, `crawler_process_crawl_denied_urls`, `crawler_user_agent`, `delete_crawler_active_crawl_request`, `delete_crawler_crawl_rule`, `delete_crawler_crawl_schedule`, `delete_crawler_domain`, `delete_crawler_entry_point`, `delete_crawler_sitemap`, `list_crawler_crawl_requests`, `list_crawler_process_crawls`.
+
+[discrete]
+===== New APIs
+
+* `list_crawler_domain`: Lists crawler domains given an engine.
+* Adaptive Relevance Suggestion APIs:
+** `adaptive_relevance_suggestions` - Retrieves adaptive relevance for a single query.
+** `list_adaptive_relevance_suggestions` - List the adaptive relevance suggestions for a given engine.
+** `put_adaptive_relevance_suggestions` - Update adaptive relevance.
+* Adaptive Relevance Settings APIs:
+** `adaptive_relevance_settings` - Retrieve adaptive relevance settings.
+** `put_adaptive_relevance_settings` - Update adaptive relevance settings.
+** `refresh_adaptive_relevance_update_process` - Update suggestions process refresh.
 
+[discrete]
+==== Enterprise Search
+
+- Read-Only API: `put_read_only` body is now required with the enabled object: `{enabled: true|false}`.
+- APIs where `body` has been removed since it's not used: `health`, `read_only`, `stats`, `version`.
+
+[discrete]
+==== Workplace Search
+
+[discrete]
+===== API Changes
+
+* Permissions APIs have been removed: `add_user_permissions`, `list_permissions`, `put_user_permissions`, `remove_user_permissions`, `user_permissions`.
+* `current_user` removed `get_token` parameter.
+* Analytics: `create_analytics_events` will raise ArgumentError if body is missing (Required: type, query_id, page, content_source_id, document_id, rank)
+* Content Sources: `create_content_source` will raise ArgumentError if body is missing (Required: name). `name` cannot be passed in as a parameter anymore, needs to be in the body. `put_content_source` will raise ArgumentError if body is missing (Required: name, is_searchable). `put_content_source_icons` will raise ArgumentError if body is missing.
+* External Identities: `create_external_identity` will raise ArgumentError if body is missing (Required: external_user_id, external_user_properties, permissions). Body parameters have changed:
+
++
+[source,rb]
+----------------------------
+body = {
+  external_user_id: external_user_id,
+  permissions: [],
+  external_user_properties: [
+    'attribute_name' => '_elasticsearch_username',
+    'attribute_value' => 'fernando'
+  ]
+}
+client.create_external_identity(content_source_id, body: body)
+----------------------------
++
+In `delete_external_identity`, `external_identity` and `put_external_identity` the required parameter changed from `user` to `external_user_id`.
+See https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html
+* Search: Parameters need to be passed in via body to `search`. It will raise ArgumentError if body is missing.
+* Documents: `delete_documents` will raise ArgumentError if body is missing (Required document_ids).
+* Sync Jobs: `command_sync_jobs` will raise ArgumentError if body is missing.
+* Synonyms: `create_batch_synonym_sets`, `put_synonym_set` will raise ArgumentError if body is missing.
+* APIs where `body` has been removed since it's not used: `auto_query_refinement_details`, `content_source`, `current_user`, `delete_content_source`, `delete_external_identity`, `delete_synonym_set`, `document`, `external_identity`, `list_content_sources`, `list_external_identities`, `put_triggers_blocklist`, `synonym_set`, `triggers_blocklist`.
+
+[discrete]
+===== New APIs
+- `list_documents`: Lists documents from a custom content source.

data/docs/guide/release_notes/index.asciidoc

@@ -1,12 +1,9 @@
 [[release_notes]]
 == Release Notes
 
-
 [discrete]
 === 8.x
-
-* <<release_notes_80, 8.0.0.pre Release Notes>>
-
+* <<release_notes_80, 8.0.0 Release Notes>>
 
 [discrete]
 === 7.x

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

@@ -6,10 +6,10 @@
 [source,rb]
 ----------------------------
 # Create a custom content source
-client.create_content_source(name: 'test')
+client.create_content_source(body: { name: 'test' })
 
 # Retrieve a content source by ID
-content_source_id = client.create_content_source(name: 'books').body['id']
+content_source_id = client.create_content_source(body: { name: 'books' }).body['id']
 client.content_source(content_source_id)
 
 # Delete a content source by ID
@@ -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'])
 
@@ -136,21 +139,28 @@ client.remove_user_permissions(
 [source,rb]
 ----------------------------
 # Create external identities
-body = { user: 'elastic_user', source_user_id: 'example@elastic.co' }
+body = {
+  external_user_id: external_user_id,
+  permissions: [],
+  external_user_properties: [
+    'attribute_name' => '_elasticsearch_username',
+    'attribute_value' => 'fernando'
+  ]
+}
 client.create_external_identity(content_source_id, body: body)
 
 # Retrieve an external identity
-client.external_identity(content_source_id, user: 'elastic_user')
+client.external_identity(content_source_id, external_user_id: external_user_id)
 
 # List external identities
 client.list_external_identities(content_source_id)
 
 # Update external identity
-body = { source_user_id: 'example2@elastic.co' }
-client.put_external_identity(content_source_id, user: 'elastic_user', body: body)
+body = { external_user_id: external_user_id, permissions: ['permission1'] }
+client.put_external_identity(content_source_id, external_user_id: external_user_id, body: body)
 
 # Delete an external identity
-client.delete_external_identity(content_source_id, user: 'elastic_user')
+client.delete_external_identity(content_source_id, external_user_id: external_user_id)
 ----------------------------
 
 === Search

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.0.0.pre'
+    VERSION = '8.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.0.0.pre
+  version: 8.0.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -411,9 +411,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: