IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Release Notes
editRelease Notes
edit8.x
edit7.x
edit8.2.0 Release Notes
editAdded
edit-
Added
AsyncAppSearch
,AsyncEnterpriseSearch
, andAsyncWorkplaceSearch
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 toApiError
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) andbody
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
andparams
parameters for all API methods. -
Deprecated setting transport options
http_auth
,ignore
,request_timeout
, andheaders
in API methods. All of these settings should be set via the.options()
method instead.
7.17.0 Release Notes
editGeneral
edit- Updated APIs to the 7.17 specification
App Search
edit-
Added the
current_page
andpage_size
parameters to thelist_crawler_crawl_requests
andlist_crawler_process_crawls
APIs
7.16.0 Release Notes
editGeneral
edit- 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
edit-
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
andlist_crawler_process_crawls
APIs tocurrent_page
andpage_size
, were previouslylimit
.
Workplace Search
edit-
Added the
list_documents
API
7.15.0 Release Notes
editGeneral
edit- Updated APIs to the 7.15 specification
App Search
edit-
Added the
delete_crawler_active_crawl_request
,get_crawler_active_crawl_request
,create_crawler_crawl_request
,get_crawler_crawl_request
,list_crawler_crawl_requests
,create_crawler_crawl_rule
,delete_crawler_crawl_rule
,put_crawler_crawl_rule
,delete_crawler_crawl_schedule
,get_crawler_crawl_schedule
,put_crawler_crawl_schedule
,create_crawler_domain
,delete_crawler_domain
,get_crawler_domain
,put_crawler_domain
,get_crawler_domain_validation_result
,create_crawler_entry_point
,delete_crawler_entry_point
,put_crawler_entry_point
,get_crawler_metrics
,get_crawler_overview
,create_crawler_process_crawl
,get_crawler_process_crawl_denied_urls
,get_crawler_process_crawl
,list_crawler_process_crawls
,create_crawler_sitemap
,delete_crawler_sitemap
,put_crawler_sitemap
,get_crawler_url_extraction_result
,get_crawler_url_tracing_result
,get_crawler_url_validation_result
,get_crawler_user_agent
APIs
Workplace Search
edit-
Added the
get_auto_query_refinement_details
,delete_documents_by_query
,get_triggers_blocklist
,put_triggers_blocklist
APIs -
Removed
delete_all_documents
API in favor of thedelete_documents_by_query
API without filters.
7.14.0 Release Notes
editGeneral
edit- Updated APIs to the 7.14 specification
App Search
edit-
Added the
create_api_key
,delete_api_key
,get_api_key
,put_api_key
, andlist_api_keys
APIs
Workplace Search
edit-
Added the
create_batch_synonym_sets
,command_sync_jobs
,put_content_source_icons
,get_current_user
, anddelete_documents_by_query
,delete_synonym_set
,get_synonym_set
,put_synonym_set
, andlist_synonym_sets
APIs
7.13.0 Release Notes
editGeneral
edit- Updated APIs to the 7.13 specification
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.
-
Added the
get_document
,delete_all_documents
,get_content_source
,create_content_source
,delete_content_source
,list_content_sources
, andput_content_source
APIs.
7.12.0 Release Notes
editGeneral
edit- Updated APIs to the 7.12 specification
- Fixed encoding of objects in query string to match Ruby on Rails
Workplace Search
edit-
Added
oauth_authorize_url()
andoauth_exchange_for_access_token()
helper methods for implementing OAuth authentication.
7.11.0 Release Notes
editGeneral
edit- Changed stability of the package to Generally Available, was Beta.
- Updated APIs to the 7.11 specification
- Documentation moved from the README to elastic.co/guide
- Fixed encoding of arrays in query string to match Ruby on Rails
-
Changed
body
parameter to describe the content of the body for multiple APIs -
Added the
X-Elastic-Client-Meta
HTTP header controlled bymeta_header
parameter
App Search
edit-
Changed
body
parameter todocument_ids
fordelete_documents()
andget_documents()
APIs -
Changed
body
parameter todocuments
forindex_documents()
andput_documents()
APIs -
Changed
body
parameter tosource_engines
foradd_meta_engine_source()
anddelete_meta_engine_source()
APIs -
Changed
queries
parameter tobody
formulti_search()
API -
Changed
body
parameter toschema
forput_schema()
API -
Changed
synonyms
parameter tobody
forcreate_synonym_set()
andput_synonym_set()
APIs
Workplace Search
edit-
Added
create_analytics_event()
API -
Changed
content_source_key
parameter of all APIs tocontent_source_id
-
Changed
body
parameter todocuments
forindex_documents()
API -
Changed
body
parameter todocument_ids
fordelete_documents()
API
7.10.0-beta1 Release Notes
editGeneral
edit- Updated APIs to the 7.10 specification
App Search
edit-
Added
get_api_logs()
,get_count_analytics()
,create_curation()
,delete_curation()
,get_curation()
,put_curation()
,list_curations()
,delete_documents()
,get_documents()
,index_documents()
,list_documents()
,put_documents()
,create_engine()
,delete_engine()
,get_engine()
,list_engines()
,log_clickthrough()
,add_meta_engine_source()
,delete_meta_engine_source()
,multi_search()
,query_suggestion()
,get_schema()
,put_schema()
,search
get_search_settings()
,put_search_settings()
,reset_search_settings()
,create_synonym_set()
,delete_synonym_set()
,get_synonym_set()
,put_synonym_set()
,list_synonym_sets()
,get_top_clicks_analytics()
, andget_top_queries_analytics
APIs -
Added
create_signed_search_key()
method for creating Signed Search keys
Workplace Search
edit-
Added
delete_documents()
,index_documents()
,list_external_identities()
,create_external_identity()
,delete_external_identity()
,get_external_identity()
,put_external_identity()
,list_permissions()
,add_user_permissions()
,get_user_permissions()
,put_user_permissions()
,remove_user_permissions()
, andsearch()
APIs
Enterprise Search
edit-
Added
get_health()
,get_read_only()
,put_read_only()
,get_stats()
, andget_version()
APIs