IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›enterprise-search-python [8.4]
« Enterprise Search APIs

Release Notesedit

8.xedit

7.xedit

8.4.0 Release Notesedit

Addededit

  • Added the app_search.search_es_search API method.

Changededit

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

8.3.0 Release Notesedit

Addededit

  • 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

Fixededit

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

Removededit

  • 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 Notesedit

Addededit

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

Changededit

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

Removededit

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

Deprecatededit

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

7.17.0 Release Notesedit

Generaledit

  • Updated APIs to the 7.17 specification

App Searchedit

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

7.16.0 Release Notesedit

Generaledit

  • 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 Searchedit

  • 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 Searchedit

  • Added the list_documents API

7.15.0 Release Notesedit

Generaledit

  • Updated APIs to the 7.15 specification

App Searchedit

  • 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 Searchedit

  • 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 the delete_documents_by_query API without filters.

7.14.0 Release Notesedit

Generaledit

  • Updated APIs to the 7.14 specification

App Searchedit

  • Added the create_api_key, delete_api_key, get_api_key, put_api_key, and list_api_keys APIs

Workplace Searchedit

  • Added the create_batch_synonym_sets, command_sync_jobs, put_content_source_icons, get_current_user, and delete_documents_by_query, delete_synonym_set, get_synonym_set, put_synonym_set, and list_synonym_sets APIs

7.13.0 Release Notesedit

Generaledit

  • Updated APIs to the 7.13 specification

Workplace Searchedit

  • 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, and put_content_source APIs.

7.12.0 Release Notesedit

Generaledit

  • Updated APIs to the 7.12 specification
  • Fixed encoding of objects in query string to match Ruby on Rails

Workplace Searchedit

  • Added oauth_authorize_url() and oauth_exchange_for_access_token() helper methods for implementing OAuth authentication.

7.11.0 Release Notesedit

Generaledit

  • 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 by meta_header parameter

App Searchedit

  • Changed body parameter to document_ids for delete_documents() and get_documents() APIs
  • Changed body parameter to documents for index_documents() and put_documents() APIs
  • Changed body parameter to source_engines for add_meta_engine_source() and delete_meta_engine_source() APIs
  • Changed queries parameter to body for multi_search() API
  • Changed body parameter to schema for put_schema() API
  • Changed synonyms parameter to body for create_synonym_set() and put_synonym_set() APIs

Workplace Searchedit

  • Added create_analytics_event() API
  • Changed content_source_key parameter of all APIs to content_source_id
  • Changed body parameter to documents for index_documents() API
  • Changed body parameter to document_ids for delete_documents() API

7.10.0-beta1 Release Notesedit

Generaledit

  • Updated APIs to the 7.10 specification

App Searchedit

  • 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(), and get_top_queries_analytics APIs
  • Added create_signed_search_key() method for creating Signed Search keys

Workplace Searchedit

  • 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(), and search() APIs

Enterprise Searchedit

  • Added get_health(), get_read_only(), put_read_only(), get_stats(), and get_version() APIs
« Enterprise Search APIs