A newer version is available. Check out the latest documentation.

Release Notes

edit

8.18.0 Release Notes

edit

Client is compatible with Elastic Enterprise Search 8.18.0

App Search and Workplace Search will be discontinued in 9.0

Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy. We recommend transitioning to our actively developed Elastic Stack tools for your search use cases. However, if you’re still using any Enterprise Search products, we recommend using the latest stable release of the clients.

Here are some useful links with more information:

8.10.0 Release Notes

edit

Client is compatible with Elastic Enterprise Search 8.11.0

Added

edit
  • Added supported for Python 3.12.

8.10.0 Release Notes

edit

Client is compatible with Elastic Enterprise Search 8.10.0

Added

edit
  • Added get_storage, get_stale_storage and delete_stale_storage to enterprise_search.
  • Added precision_enabled parameter name to app_search.put_search_settings.

Fixed

edit
  • Fixed boosts parameter name in app_search.search and app_search.search_explain.

8.4.0 Release Notes

edit

Added

edit
  • Added the app_search.search_es_search API method.

Changed

edit
  • Changed URL parsing to use default ports for http and https schemes instead of raising an error.

8.3.0 Release Notes

edit

Added

edit
  • Added the current_page parameter to many APIs that support pagination.
  • Added the app_search.multi_search API for v8.x
  • Added the enterprise_search.get_search_engines API

Fixed

edit
  • Fixed the overrides parameter of the app_search.get_top_queries_analytics and create_crawler_crawl_request APIs

Removed

edit
  • Removed unused created_at parameters for various create_* APIs. These parameters weren’t used by the server and were only generated due to issues with the API specification.

8.2.0 Release Notes

edit

Added

edit
  • Added AsyncAppSearch, AsyncEnterpriseSearch, and AsyncWorkplaceSearch clients which have async API methods.
  • Added the top-level .options() method to all client classes for modifying options per request.
  • Added parameters for JSON request body fields for all APIs
  • Added basic_auth parameter for specifying username and password authentication.
  • Added bearer_auth parameter for specifying authentication with HTTP Bearer tokens.
  • Added the meta property to ApiError and subclasses to access the HTTP response metadata of an error.
  • Added a check that a compatible version of elastic-transport package is installed.

Changed

edit
  • Changed responses to be objects with two properties, meta for response metadata (HTTP status, headers, node, etc) and body for the raw deserialized body object.

Removed

edit
  • Removed support for Python 2.7 and Python 3.5. The package now requires Python 3.6 or higher.
  • Removed the default URL of http://localhost:3002. The URL must now be specified explicitly, including scheme and port.
  • Removed the ability to use positional arguments with API methods. Going forward all API parameters must be specified as keyword parameters.

Deprecated

edit
  • Deprecated the body and params parameters for all API methods.
  • Deprecated setting transport options http_auth, ignore, request_timeout, and headers in API methods. All of these settings should be set via the .options() method instead.