8.11.0

Client is compatible with Elastic Enterprise Search 8.11.0

Added

• Added supported for Python 3.12.

8.10.0

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.

8.4.0

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.

8.3.0

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.

8.2.0

⚠️ 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

8.1.0-alpha1

⚠️ 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

7.17.0

General

• Updated APIs to the 7.17 specification

App Search

• Added the current_page and page_size parameters to the list_crawler_crawl_requests and list_crawler_process_crawls APIs

7.16.0

Client

• Deprecated support for Python 2.7, 3.4, and 3.5. Support will be removed in v8.0.0.
• Updated APIs to the 7.16 specification

App Search

• Added the get_adaptive_relevance_settings, put_adaptive_relevance_settings, get_adaptive_relevance_suggestions, list_adaptive_relevance_suggestions, put_adaptive_relevance_suggestions
• Fixed the pagination parameters for list_crawler_crawl_requests and list_crawler_process_crawls APIs to current_page and page_size, were previously limit.

Workplace Search

• Added the list_documents API

7.15.0

APIs

App Search

• Added the delete_crawler_active_crawl_request API
• Added the get_crawler_active_crawl_request API
• Added the create_crawler_crawl_request API
• Added the get_crawler_crawl_request API
• Added the list_crawler_crawl_requests API
• Added the create_crawler_crawl_rule API
• Added the delete_crawler_crawl_rule API
• Added the put_crawler_crawl_rule API
• Added the delete_crawler_crawl_schedule API
• Added the get_crawler_crawl_schedule API
• Added the put_crawler_crawl_schedule API
• Added the create_crawler_domain API
• Added the delete_crawler_domain API
• Added the get_crawler_domain API
• Added the put_crawler_domain API
• Added the get_crawler_domain_validation_result API
• Added the create_crawler_entry_point API
• Added the delete_crawler_entry_point API
• Added the put_crawler_entry_point API
• Added the get_crawler_metrics API
• Added the get_crawler_overview API
• Added the create_crawler_process_crawl API
• Added the get_crawler_process_crawl_denied_urls API
• Added the get_crawler_process_crawl API
• Added the list_crawler_process_crawls API
• Added the create_crawler_sitemap API
• Added the delete_crawler_sitemap API
• Added the put_crawler_sitemap API
• Added the get_crawler_url_extraction_result API
• Added the get_crawler_url_tracing_result API
• Added the get_crawler_url_validation_result API
• Added the get_crawler_user_agent API

Workplace Search

• Added the get_auto_query_refinement_details API
• Added the put_content_source_icons API
• Added the delete_documents_by_query API
• Added the get_triggers_blocklist API
• Added the put_triggers_blocklist API
• Removed the delete_all_documents API in favor of the delete_documents_by_query API without filters.

7.14.0

APIs

App Search

• Added the create_api_key API
• Added the delete_api_key API
• Added the get_api_key API
• Added the put_api_key API
• Added the list_api_keys API

Workplace Search

• Added the create_batch_synonym_sets API
• Added the command_sync_jobs API
• Added the put_content_source_icons API
• Added the get_current_user API
• Added the delete_synonym_set API
• Added the get_synonym_set API
• Added the put_synonym_set API
• Added the list_synonym_sets API