Elastic-enterprise-search

Client is compatible with Elastic Enterprise Search 8.11.0

Added

- Added supported for Python 3.12.

Client is compatible with Elastic Enterprise Search 8.10.0

Added

- 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

- Fixed `boosts` parameter name in `app_search.search` and `app_search.search_explain`.

Added

* Added the `app_search.search_es_search` API method.

Client

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

Added

- 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

- Fixed the `overrides` parameter of the `app_search.get_top_queries_analytics` and `create_crawler_crawl_request` APIs


Removed

- 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.

:warning: **This is a new major release and contains some breaking changes.**

Client

Added

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

Changed

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

Removed

- Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
- Removed the default URL of `http://localhost:3002`. URL must be specified explicitly.
- Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

- Deprecated the `body` and `params` parameters on all APIs
- Deprecated setting transport options `http_auth`, `ignore`, `request_timeout`, and `headers`
All of these settings should instead be set via the `.options()` method

:warning: **This is a new major release and contains some breaking changes.**

Client

Added

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

Changed

- Changed user-defined `body` parameters to have semantic names (e.g `index_documents(documents={...})` instead of `index_documents(body={...})`).
- Changed responses to be objects with two properties, `meta` for response metadata (HTTP status, headers, node, etc) and `body` for a typed body.

Removed

- Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
- Removed the default URL of `http://localhost:3002`. URL must be specified explicitly.
- Removed the ability to use positional arguments with API methods. Going forward all API parameters must be keyword-only parameters

Deprecated

- Deprecated the `body` and `params` parameters on all APIs
- Deprecated setting transport options `http_auth`, `api_key`, `ignore`, `request_timeout`, and `headers`
All of these settings should instead be set via the `.options()` method