Release Notes
editRelease Notes
edit7.x
edit7.16 Release notes
editGeneral
edit- Tested with Elastic Enterprise Search API version 7.16.0.
App Search
edit-
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 Elastic Cloud and 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
edit-
Adds
list_documents
- List documents from a custom content source
7.15 Release notes
edit7.15.1 Release notes
editDependency fix
editUpdates dependency on elasticsearch-transport
to be more open. At least 7.11 is required, but this way it can be used with different versions of the elasticsearch
gem (bigger than or equal to 7.11
) in the same project, without a conflict in elasticsearch-transport
. When instantiating transport, we now check if version is < 7.14
so we use the right class.
7.15.0 Release notes
editGeneral
edit- Tested with Elastic Enterprise Search API version 7.15.0.
- Better source code documentation in general for API endpoints.
App Search
edit- The test suite was migrated to full integration testing in Jenkins. We were using VCR for testing the API, but now we’re running the API tests against an instance of Elastic Enterprise Search.
-
Some APIs that used to work with
GET
query parameters in App Search are nowPOST
and the parameters being sent with the body. We’ll use the body from7.15
, but we’ll keep supporting arguments parameters in 7.x for backwards compatibility. Some parameters previously required through the generated code don’t throw an exception anymore and the error is delegated to server. As mentioned, these should go through the body instead of part of the query parameters, but we still support sending them as query parameters in7.x
to keep backwards compatibility.
Web Crawler API
editThe 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.
New Web Crawler API endpoints:
crawler_active_crawl_request
, crawler_crawl_request
, crawler_crawl_schedule
, crawler_domain
, crawler_domain_validation_result
, crawler_metrics
, crawler_overview
, crawler_process_crawl_denied_urls
, crawler_process_crawl
, crawler_url_extraction_result
, crawler_url_tracing_result
, crawler_url_validation_result
, crawler_user_agent
, create_crawler_crawl_request
, create_crawler_crawl_rule
, create_crawler_domain
, create_crawler_entry_point
, create_crawler_process_crawl
, create_crawler_sitemap
, delete_active_crawl_request
, 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
, put_crawler_crawl_rule
, put_crawler_crawl_schedule
, put_crawler_domain
, put_crawler_entry_point
, put_crawler_sitemap
.
Refer to App Search API for more information and examples.
Workplace Search
edit-
New APIs:
auto_query_refinement_details
,triggers_blocklist
andput_triggers_blocklist
. See Workplace Search API for more information and examples.
7.14 Release notes
edit7.14.1 Release notes
editDependency fix
editUpdates dependency on elasticsearch-transport
to be more open. At least 7.11 is required, but this way it can be used with different versions of the elasticsearch
gem (bigger than or equal to 7.11
) in the same project, without a conflict in elasticsearch-transport
. When instantiating transport, we now check if version is < 7.14
so we use the right class.
7.14.0 Release notes
editGeneral
edit- Tested with Elastic Enterprise Search API version 7.14.0.
App Search
edit-
Adds API Key endpoints:
api_key
,create_api_key
,delete_api_key
,list_api_keys
,put_api_key
Workplace Search
edit-
Adds synonym set endpoints:
create_batch_synonym_sets
,delete_synonym_set
,list_synonym_sets
,put_synonym_set
,synonym_set
-
Adds
current_user
endpoint -
Adds
command_sync_jobs
endpoint -
Adds
delete_documents_by_query
endpoint -
Adds
put_content_source_icons
endpoint
7.13.0 Release notes
editGeneral
edit- Tested with Elastic Enterprise Search API version 7.13.0.
- Improved meta header implementation for Elastic Cloud.
Workplace Search
edit- The client now supports Basic Authentication and Elasticsearch tokens. All Workplace Search APIs support Basic Authentication, Elasticsearch tokens and Workplace Search admin user access tokens as an authentication method. You still need to set up user access tokens generated by the Workplace Search OAuth Service for the Search API and the Analytics Events API.
-
New APIs:
-
document
: Retrieve a document by ID from a specified content source. -
delete_all_documents
: Delete all documents for a given content source -
content_source
: Retrieves a content source by ID -
create_content_source
: Creates a custom content source -
delete_content_source
: Deletes a content source by ID -
list_content_sources
: Retrieves all content sources -
put_content_source
: Updates a custom content source
-
7.12 Release notes
edit7.12.1 Release notes
edit- Elastic Transport: Locks dependency version to < 7.14
- Elastic Transport: Adds ENTERPRISE_SERVICE_VERSION constant for compatibility
7.12.0 Release notes
editGeneral
edit- Tested with Elastic Enterprise Search API version 7.12.0.
- Adds multi filter example to App Search docs.
-
Bumps
elasticsearch-transport
dependency to version 7.11 and up. -
Updates
run-local
script to fix rakestack
task.
App Search
edit-
Updates source code documentation for
current_page
andpage_size
parameters from typeString
toInteger
. -
In
multi_search
, the body parameter is renamed tobody
fromqueries
to avoid repetition and potential confusion.
7.11.0 Release notes
editFirst General Availability Release
General
edit- All App Search, Workplace Search and Enterprise Search API endpoints have been implemented updated to the 7.11 specification, and have been tested and documented.
- Docs were moved from the README file to asciidocs.
-
Some endpoints both in App Search and Workplace Search have changed to have named parameters for
body
when it makes sense. - Support for per request custom HTTP headers was added. See docs.
- Support for per request http authentication was added when using OAuth. See docs.
- Tested with Ruby 3.
-
Sends the
X-Elastic-Client-Meta
HTTP header which is used by Elastic Cloud and can be disabled with theenable_meta_header
parameter.
App Search
edit- Added support for signed search key in App Search.
Workplace Search
edit-
content_source_key
was deprecated in favour ofcontent_source_id
. - Added support for OAuth.
-
With OAuth support,
search
andcreate_analytics
APIs are now also available.
7.10.0.beta.1 Release notes
editFirst beta release. It supports the 7.10.0 API for Elastic Enterprise Search, App Search and Workplace Search.