Skip to content

Conversation

@elastic-renovate-prod
Copy link

@elastic-renovate-prod elastic-renovate-prod bot commented Sep 17, 2025

This PR contains the following updates:

Package Update Change
elasticsearch major ~=7.10.0 -> ~=9.2.1

Release Notes

elastic/elasticsearch-py (elasticsearch)

v9.2.1: 9.2.1

Compare Source

Enhancements

  • Instrument ping with OTel (#​3160)
  • Make positional arguments in DSL generated classes explicit (#​3233)
  • Add warnings for private APIs (#​3212)

Bug fixes

  • ES|QL query builder: fix missing assignment (#​3151)
  • Use relative imports to fix elasticsearch9 package imports (#​3232)

API

  • Added transform.get_node_stats API
  • Added requests_per_second argument to delete_by_query_rethrottle, reindex_rethrottle and update_by_query_rethrottle APIs
  • Added allow_closed, allow_no_indices, expand_wildcards, ignore_throttled and ignore_available arguments to cat.segments API
  • Added chunking_settings argument to inference.put_watsonxai API
  • Added id argument to ml.stop_trained_model_deployment API
  • Removed chunking_settings argument from inference.put_anthropic, inference.put_contextualai, inference.put_deepseek APIs

DSL

  • Removed on_disk_score argument from DenseVectorIndexOptions type

v9.2.0: 9.2.0

Compare Source

Enhancements
  • Support Trio when using the HTTPX async client (#​3089)
  • Pydantic integration for the DSL module (#​3086)
  • Add flush_after_seconds option to streaming_bulk() (#​3064)
  • Add TS, FUSE and INLINE STATS commands to the ES|QL query builder (#​3096)
Bug Fixes
  • DSL: support passing inner documents as AttrDict instances (#​3080)
  • DSL: add some recently added field classes as top-level exports for the package (#​3078)
API
  • Add streams namespace with streams.logs_disable, streams.logs_enable, streams.status APIs
  • Add inference.contextualai API
  • Add security.get_stats API
  • Add bytes and time parameters to various APIs in the cat namespace.
  • Add include_execution_metadata parameter to esql.async_query and esql.query APIs
  • Add index_template parameter to indices.simulate_index_template API
  • Add input_type parameter to inference.text_embedding API
  • Add field_access_pattern parameter to ingest.put_pipeline API
  • Removed unsupported size parameter from reindex API
Serverless-specific
  • Add project namespace with project.tags API
  • Add project_routing parameter to count, field_caps, msearch, msearch_template, open_point_in_time, search, search_mvt, search_template, async_search.submit, cat.count, eql.search, indices.resolve_index, sql.query APIs
DSL
  • New CartesianBounds, CartesianCentroid, ChangePoint aggregations
  • Add p_value parameter to SignificantTerms aggregation
  • Add fields parameter to SemanticText field
  • Add visit_percentage parameter to Knn query
  • Add on_disk_rescore field to DenseVectorIndexOptions type
  • Add sparse_vector field to SemanticTextIndexOptions type
Other

v9.1.3

Compare Source

v9.1.2: 9.1.2

Compare Source

Enhancements
  • Add flush_after_seconds option to streaming_bulk() (#​3064)
Bug Fixes
  • DSL: support passing inner documents as AttrDict instances (#​3080)
  • DSL: add some recently added field classes as top-level exports for the package (#​3078)
API
  • Add streams namespace with streams.logs_disable, streams.logs_enable, streams.status APIs
  • Add bytes and time parameters to various APIs in the cat namespace.
  • Add index_template parameter to indices.simulate_index_template API
  • Add input_type parameter to inference.text_embedding API
DSL
  • New CartesianBounds, CartesianCentroid, ChangePoint aggregations
  • Add p_value parameter to SignificantTerms aggregation
  • Add index_options and fields parameters to SemanticText field
  • Add visit_percentage parameter to Knn query
  • Add on_disk_rescore field to DenseVectorIndexOptions type
Other

v9.1.1: 9.1.1

Compare Source

Enhancements and Fixes

  • ES|QL query builder integration with the DSL module (#​3058)
  • ES|QL query builder robustness fixes (#​3017)
  • Fix ES|QL multi_match() signature (#​3052)

API

  • Add support for ES|QL query builder objects to ES|QL Query and Async Query APIs
  • Add Transform Set Upgrade Mode API
  • Fix type of fields parameter of Term Vectors API to array of strings
  • Fix type of params parameter of SQL Query API to array

DSL

  • Preserve the skip_empty setting in to_dict() recursive serializations (#​3041)
  • Add separator_group and separators attributes to ChunkingSettings type
  • Add primary attribute to ShardFailure type
  • Fix type of key attribute of ArrayPercentilesItem to float

v9.1.0: 9.1.0

Compare Source

Enhancements

  • ES|QL query builder (technical preview) (#​2997)
  • Update OpenTelemetry conventions (#​2999)
  • Add option to disable accurate reporting of file and line location in warnings (Fixes #​3003) (#​3006)

APIs

  • Remove if_primary_term, if_seq_no and op_type from Create API
  • Remove master_timeout from Ingest Get Ip Location Database API
  • Remove application, priviledge and username from the Security Get User API
  • Rename type_query_string to type in License Post Start Trial API
  • Add require_data_stream to Index API
  • Add settings_filter to Cluster Get Component Template API
  • Add cause to Cluster Put Component Template API
  • Add master_timeout to Cluster State API
  • Add ccs_minimize_roundtrips to EQL Search API
  • Add keep_alive and keep_on_completion to ES|QL Async Query API
  • Add format to ES|QL Async Query Get API
  • Add ES|QL Get Query and List Queries APIs
  • Add Indices Delete Data Stream Options API
  • Add Indices Get Data Stream Options and Put Data Stream Options APIS
  • Add Indices Get Data Stream Settings and Put Data Stream Settings APIs
  • Add allow_no_indices, expand_wildcards and ignore_available to Indices Recovery API
  • Add Indices Remove Block API
  • Add Amazon Sagemaker to Inference API
  • Add input_type to Inference API
  • Add timeout to all Inference Put APIs
  • Add Inference Put Custom API
  • Add Inference Put DeepSeek API
  • Add task_settings to Put HuggingFace API
  • Add refresh to Security Grant API Key API
  • Add wait_for_completion to the Snapshot Delete API
  • Add state to Snapshot Get API
  • Add refresh to Synonyms Put Synonym, Put Synonym Rule and Delete Synonym Rule APIs

DSL

  • Handle lists in copy_to option in DSL field declarations correctly (Fixes #​2992) (#​2993)
  • Add index_options to SparseVector type
  • Add SparseVectorIndexOptions type
  • Add key to FiltersBucket type

Other changes

  • Drop support for Python 3.8 (#​3001)

v9.0.5

Compare Source

v9.0.4: 9.0.4

Compare Source

Enhancements and Fixes

  • ES|QL query builder integration with the DSL module (#​3058)
  • ES|QL query builder robustness fixes (#​3017)
  • Fix ES|QL multi_match() signature (#​3052)

API

  • Add support for ES|QL query builder objects to ES|QL Query and Async Query APIs
  • Add Transform Set Upgrade Mode API
  • Fix type of fields parameter of Term Vectors API to array of strings
  • Fix type of params parameter of SQL Query API to array

DSL

  • Preserve the skip_empty setting in to_dict() recursive serializations (#​3041)
  • Add primary attribute to ShardFailure type
  • Fix type of key attribute of ArrayPercentilesItem to float

v9.0.3: 9.0.3

Compare Source

Enhancements

  • ES|QL query builder (technical preview) (#​2997)
  • Add option to disable accurate reporting of file and line location in warnings (Fixes #​3003) (#​3006)

APIs

  • Remove if_primary_term, if_seq_no and op_type from Create API
  • Remove stored_fields from Get Source API
  • Remove master_timeout from Ingest Get Ip Location Database API
  • Remove application, priviledge and username from the Security Get User API
  • Rename type_query_string to type in License Post Start Trial API
  • Add require_data_stream to Index API
  • Add settings_filter to Cluster Get Component Template API
  • Add cause to Cluster Put Component Template API
  • Add ccs_minimize_roundtrips to EQL Search API
  • Add keep_alive and keep_on_completion to ES|QL Async Query API
  • Add format to ES|QL Async Query Get API
  • Add allow_no_indices, expand_wildcards and ignore_available to Indices Recovery API
  • Add timeout to all Inference Put APIs
  • Add refresh to Security Get User Profile API
  • Add wait_for_completion to the Snapshot Delete API

DSL

  • Handle lists in copy_to field option correctly (Fixes #​2992) (#​2993)
  • Add key to FiltersBucket type

v9.0.2: 9.0.2

Compare Source

DSL

  • Add rescore_vector to DenseVectorIndexOptions

v9.0.1: 9.0.1

Compare Source

  • Surface caused_by in ApiError (#​2932)
  • Clarify Elasticsearch 9.x compatibility (#​2928)
  • Reorganize Sphinx docs to only include reference pages (#​2776)

v9.0.0: 9.0.0

Compare Source

[!IMPORTANT]
Upgrade to Elasticsearch 9 before using elasticsearch-py 9.0.0 or later. Using elasticsearch-py 9.0.0 on an Elasticsearch 8 server will fail.
Since language clients are forward-compatible, you should first upgrade Elasticsearch, then the Elasticsearch client. See the compatibility documentation for more details.

  • Remove deprecated Elasticsearch() options (#​2840)
  • Remove deprecated url_prefix and use_ssl options (#​2797)
  • Merge Elasticsearch-DSL package (#​2736)
  • Add Python DSL documentation (#​2761)
  • Autogenerate DSL field classes from schema (#​2780)
  • Improve DSL documentation examples with class-based queries and type hints (#​2857)
  • Document the use of param() in Python DSL methods (#​2861)
  • Migrate documentation from AsciiDoc to Markdown format (#​2806)
  • Document use of sub-clients (#​2798)
  • Document how to making API calls (#​2843)
  • Fix simulate sub-client documentation (#​2749)
  • Update APIs
    • Remove Unfreeze an index API
    • Remove min_compatible_shard_node from Search and Async Search Submit APIs
    • Remove local parameter from cat alias, Alias exists, and Get alias APIs
    • Remove verbose from Index segments API
    • Remove include_model_definition from Get trained model configuration info API
    • Remove wait_for_active_shards from experimental Get field usage stats API
    • Support soft-deletes in connectors:
      • Add hard to Delete connector API
      • Add include_deleted to Get and List Connector APIs
    • Add master_timeout to Migrate to data tiers routing APIs
    • Add master_timeout to the Alias exists and Get alias APIs.
    • Add expand_wildcards to Create snapshot API
    • Rename incorrect access_token to token in Logout of OpenID Connect API
    • Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI
    • Add Reindex legacy backing indices APIs
    • Add Create an index from a source index API
    • Add include_source_on_error to Create, Index, Update and Bulk APIs
    • Add Stop async ES|QL query API
    • Add timeout to Resolve Cluster API
    • Add adaptive_allocations body field to Start and Update a trained model deployment API
    • Rename index_template_subtitutions to index_template_substitutions in Simulate data ingestion API* Add if_primary_term, if_seq_no, op_type, require_alias and require_data_stream to Create API
    • Add max_concurrent_shard_requests to Open point in time API
    • Add local and flat_settings to Check index templates API
    • Add reopen to Update index settings API
    • Add resource to Reload search analyzer API
    • Add lazy to Roll over to a new index API
    • Add cause and create to Simulate index template APIs
    • Add Elastic Inference Service (EIS) chat completion
    • Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI
  • Update DSL
    • Add ignore_malformed, script, on_script_error and time_series_dimension to Boolean field
    • Add index to GeoShape field
    • Add search_inference_id to SemanticText field

v8.19.3: 8.19.3

Compare Source

Enhancements

  • Instrument ping with OTel (#​3160)
  • Add warnings for private APIs (#​3212)
  • Make positional arguments in DSL generated classes explicit (#​3233)

Bug fixes

  • ES|QL query builder: fix missing assignment (#​3151)
  • Use relative imports to fix elasticsearch9 package imports (#​3232)

API

  • Added indices.delete_data_stream_options, indices.get_data_stream_options and indices.put_data_stream_options APIs
  • Added transform.get_node_stats API
  • Added requests_per_second argument to delete_by_query_rethrottle, reindex_rethrottle and update_by_query_rethrottle APIs
  • Added allow_closed, allow_no_indices, expand_wildcards, ignore_throttled and ignore_available arguments to cat.segments API
  • Added id argument to ml.stop_trained_model_deployment API

v8.19.2: 8.19.2

Compare Source

Enhancements
  • Add flush_after_seconds option to streaming_bulk() (#​3064)
Bug Fixes
  • DSL: support passing inner documents as AttrDict instances (#​3080)
  • DSL: add some recently added field classes as top-level exports for the package (#​3078)
API
  • Add streams namespace with streams.logs_disable, streams.logs_enable, streams.status APIs
  • Add indices.get_data_stream_settings API
  • Add indices.put_data_stream_settings API
  • Add bytes and time parameters to various APIs in the cat namespace.
  • Add index_template parameter to indices.simulate_index_template API
  • Add input_type parameter to inference.text_embedding API
  • Removed unsupported size parameter from reindex API
DSL
  • New CartesianBounds, CartesianCentroid, ChangePoint aggregations
  • Add p_value parameter to SignificantTerms aggregation
  • Add fields parameter to SemanticText field
Other

v8.19.1: 8.19.1

Compare Source

Enhancements and Fixes

  • ES|QL query builder integration with the DSL module (#​3058)
  • ES|QL query builder robustness fixes (#​3017)
  • Fix ES|QL multi_match() signature (#​3052)

API

  • Add support for ES|QL query builder objects to ES|QL Query and Async Query APIs
  • Add Amazon Sagemaker to Inference API
  • Add expand_wildcards parameter to Snapshot Create API
  • Add Transform Set Upgrade Mode API
  • Fix type of params parameter of SQL Query API to array
  • Fix type of fields parameter of Term Vectors API to array of strings

DSL

  • Preserve the skip_empty setting in to_dict() recursive serializations (#​3041)
  • Add ChunkingSettings type
  • Add SemanticTextIndexOptions type
  • Add exclude_vectors attribute to SourceFilter type
  • Add SparseVectorIndexOptions type
  • Add execution_hint attribute to TDigest type
  • Add primary attribute to ShardFailure type
  • Fix type of key attribute of ArrayPercentilesItem to float

v8.19.0: 8.19.0

Compare Source

Enhancements

  • ES|QL query builder (technical preview) (#​2997)
  • Add option to disable accurate reporting of file and line location in warnings (Fixes #​3003) (#​3006)

API updates

  • Remove if_primary_term, if_seq_no and op_type from Create API
  • Remove stored_fields from Get Source API
  • Remove min_compatible_shard_node from Async Search Submit API
  • Remove master_timeout from Cat Aliases API
  • Remove master_timeout from Ingest Get Ip Location Database API
  • Remove application, priviledge and username from the Security Get User API
  • Rename type_query_string to type in License Post Start Trial API
  • Add require_data_stream to Index API
  • Add settings_filter to Cluster Get Component Template API
  • Add cause to Cluster Put Component Template API
  • Add ccs_minimize_roundtrips to EQL Search API
  • Add keep_alive and keep_on_completion to ES|QL Async Query API
  • Add format to ES|QL Async Query Get API
  • Add allow_no_indices, expand_wildcards and ignore_available to Indices Recovery API
  • Add input_type to Inference API
  • Add timeout to all Inference Put APIs
  • Add Inference Put Custom API
  • Add refresh to Security Get User Profile API
  • Add wait_for_completion to the Snapshot Delete API

DSL Updates

  • Handle lists in copy_to option in DSL field declarations correctly (Fixes #​2992) (#​2994)
  • Add key to FiltersBucket type

v8.18.1: 8.18.1

Compare Source

  • Update APIs
    • Add back inference.inference APIs that were removed by mistake
  • Update DSL
    • Add CountedKeyword and Passthrough fields
    • Add rescore_vector to Knn query
    • Add bbq_flat and bbq_hnsw vector index types
    • Add script and on_script_error to Date and DateNanos fields

v8.18.0: 8.18.0

Compare Source

  • Merge Elasticsearch-DSL <https://github.com/elastic/elasticsearch-dsl-py/>_ package (#​2736)
  • Add Python DSL documentation (#​2761)
  • Autogenerate DSL field classes from schema (#​2780)
  • Improve DSL documentation examples with class-based queries and type hints (#​2857)
  • Document the use of param() in Python DSL methods (#​2861)
  • Document use of sub-clients (#​2798)
  • Fix simulate sub-client documentation (#​2749)
  • Update APIs
    • Remove wait_for_active_shards from experimental Get field usage stats API
    • Rename incorrect access_token to token in Logout of OpenID Connect API
    • Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI
    • Add Reindex legacy backing indices APIs
    • Add Create an index from a source index API
    • Add include_source_on_error to Create, Index, Update and Bulk APIs
    • Add Stop async ES|QL query API
    • Add timeout to Resolve Cluster API
    • Add adaptive_allocations body field to Start and Update a trained model deployment API
    • Rename index_template_subtitutions to index_template_substitutions in Simulate data ingestion API* Add if_primary_term, if_seq_no, op_type, require_alias and require_data_stream to Create API
    • Add max_concurrent_shard_requests to Open point in time API
    • Add local and flat_settings to Check index templates API
    • Add reopen to Update index settings API
    • Add resource to Reload search analyzer API
    • Add lazy to Roll over to a new index API
    • Add cause and create to Simulate index template APIs
    • Add Elastic Inference Service (EIS) chat completion
    • Add inference APIs: Alibaba Cloud AI Search, Amazon Bedrock, Anthropic, Azure AI Studio, Azure OpenAI, Cohere, Elastic Inference Service (EIS), Elasticsearch, ELSER, Google AI Studio, Google Vertex AI, Hugging Face, Jina AI, Mistral, OpenAI, and Voyage AI
  • Update DSL
    • Add ignore_malformed, script, on_script_error and time_series_dimension to Boolean field
    • Add index to GeoShape field
    • Add search_inference_id to SemanticText field

v8.17.2: 8.17.2

Compare Source

8.17.2 (2025-03-04)

  • Explain how to use sub clients in API docs (#​2798)
  • Render descriptions as Markdown in API docs
  • Update APIs
    • Add keep_alive to Submit async search API
    • Add Run and Delete async ES|QL query APIs
    • Add Get async ES|QL query results API
    • Add include_ccs_metadata to ES|QL query API

v8.17.1: 8.17.1

Compare Source

8.17.1 (2025-01-23)

  • Make pyarrow dependency optional for tests (#​2733, contributed by @​danigm)
  • Update APIs:
    • Add Simulate ingest API
    • Add Get data stream lifecycle stats API
    • Add Update inference API
    • Add Create or update, Get and Delete IP geolocation database configuration APIs
    • Add Bulk update API keys
    • Add Get and Update Security index settings APIs
    • Add OpenID Connect prepare authentication, OpenID Connect authenticate and OpenID Connect logout APIs
    • Add Delegate PKI authentication API
    • Add Repository analysis API
    • Add Render Search Application Query API
    • Add Find field structure and Find messages structure APIs
    • Add Get Watcher index settings and Update Watcher index settings APIs
    • Add experimental Check in and Claim connector sync job APIs
    • Add experimental Set connector sync job errors and Set connector sync job stats APIs
    • Add experimental Update connector features APIs
    • Add experimental Post Event to an Analytics Collection API
    • Add timeout and master_timeout to Snapshot lifecycle management (SLM) APIs
    • Add allow_partial_search_results to SQL search API
    • Add throttle_period_in_millis to Create or update watch API
    • Fix query parameters for CAT APIs

v8.17.0: 8.17.0

Compare Source

8.17.0 (2024-12-13)

  • Allow simsimd again on Python 3.13 (#​2722)
  • Update APIs:
    • Mark all Inference APIs as stable.
    • Add allow_partial_search_results to the Open Point in Time API
    • Add keep_alive to the Get async search status API
    • Remove the keep_alive, pre_filter_shard_size and scroll parameters from the Submit async search API. They were never supported.
    • Add master_timeout and timeout to all autoscaling policy APIs
    • Add master_timeout to the Alias exists and Get alias APIs
    • Add list_executed_pipelines and require_data_stream to Bulk API
    • Add include_model_definition to Get trained models API
    • Add meta to Create data frame analytics API
    • Add aggs to Create datafeeds API
    • Add allow_no_indices, expand_wildcards, ignore_throttled and ignore_unavailable to Create anomaly detection jobs API

v8.16.0: 8.16.0

Compare Source

8.16.0 (2024-11-12)

  • Support Python 3.13 (#​2680)
  • Emit Python warnings for beta and tech preview APIs (#​2675). You can disable those warnings if needed:
    import warnings
    from elasticsearch.exceptions import GeneralAvailabilityWarning
    
    warnings.filterwarnings("ignore", category=GeneralAvailabilityWarning)
  • Vectorstore: use a retriever query for hybrid search (#​2666)
  • Allow retries for statuses other than 429 in streaming bulk (#​2071, contributed by @​ayayron)
  • Make BulkIndexError and ScanError serializable (#​2669, contributed by @​seagrine)
  • Fix import when trace is missing from opentelemetry package (#​2694, contributed by @​nicoloboschi)
  • Update APIs:
    • Fix nodes parameter in Task management API (contributed by @​margaretpearce)
    • Add Test query rule API
    • Add Create Cross-Cluster API key and Update Cross-Cluster API key APIs
    • Add experimental Verify snapshot repository API
    • Add data_stream_name and settings to Delete auto-follow pattern API
    • Add max_samples_per_key to Get async EQL status API
    • Add lifecycle and remove unused data_retention and downsampling parameters from Put data stream lifecycle API
    • Add include_remotes and remove flat_settings from Cluster stats API
    • Add remote_indices to Create or update application privileges and Create or update roles APIs

v8.15.1: 8.15.1

Compare Source

8.15.1 (2024-09-08)

  • Fix OTel context loss in parallel bulk helper (#​2616)
  • Use request converter to generate python examples (#​2645)
  • Add Geoip database configuration APIs: Create or update, Get and Delete
  • Add q parameter to Update by Query API
  • Add allow_no_indices and ignore_unavailable parameters to Resolve index API

v8.15.0: 8.15.0

Compare Source

  • Added the Connector API (#​2623)
  • Added support for semantic_text and semantic query.
  • Added support for sequences of job id, model id and tags where applicable in ML APIs
  • Added dry_run and force parameters to the Perform inference API
  • Added optional Arrow deserialization support (#​2632)
  • Merged Query Ruleset API into new Query Rules API (#​2607)
  • Added mapping code examples (#​2596)
  • Fixed reference docs (#​2629)
  • Dropped Python 3.7 support (#​2618)

v8.14.0: 8.14.0

Compare Source

  • Fixed node_pool_class override (#​2581, contributed by @​tallakh)
  • Added retriever to the Search API
  • Added deprecated and removed allow_auto_create from the Create or update component template API
  • Added allow_auto_create, cause, deprecated, ignore_missing_component_templates and master_timeout to the Create or update index template API
  • Added cause, removed flat_settings and timeout from the Create or update index template legacy API
  • Removed various unsupported parameters from the Simulate index API
  • Added various supported paramters to the Simulate index template API
  • Added the completion and rerank task types to the Inference APIs
  • Added the query and timeout parameters to the Perform inference API
  • Added typed_keys to the Search Application Search API
  • Added with_profile_uid to the Get API key information and Query API key information APIs

v8.13.2: 8.13.2

Compare Source

  • Added the ml.update_trained_model_deployment API
  • Marked Requests 2.32.2 as incompatible with the Elasticsearch client

v8.13.1: 8.13.1

Compare Source

  • Added force_synthetic_source to the Get API
  • Added wait_for_completion to the Create trained model API
  • Added typed_keys to the Query API key information API

v8.13.0: 8.13.0

Compare Source

  • Added native OpenTelemetry support (#​2435)
  • Added optional orjson (a fast, correct JSON library) serialization support (#​2493)
  • Added the text_structure.test_grok_pattern API
  • Added the indices.resolve_cluster API
  • Renamed the model_id parameter to inference_id in the inference APIs
  • Changed all synonyms APIs from experimental to stable.
  • Fixed API key documentation (#​2477, contributed by @​iuliaferoli)

v8.12.1: 8.12.1

Compare Source

  • Fixed but deprecated parameter aliases in body parameter (#​2427)
  • Added mappings and bulk to quickstart page (#​2417)

v8.12.0: 8.12.0

Compare Source

  • Dropped support for Python 3.6
  • Allowed unrestricted body parameter again (see #​2383 for details)
  • Added the Inference APIs
  • Added the ES|QL API
  • Added active_only parameter to security.get_api_key API
  • Added expiration parameter to security.update_api_key API

v8.11.1: 8.11.1

Compare Source

  • Added missing role_templates to security.put_role_mapping API
  • Added interactive examples page to documentation
  • Changed API reference to have one page per sub-client

v8.11.0: 8.11.0

Compare Source

  • Added support for Python 3.12
  • Added missing scores parameter to create trained model vocabulary API
  • Added missing delete_dest_index parameter to delete transform API

v8.10.1: 8.10.1

Compare Source

  • Removed deprecation warnings when using body parameter (#​2302)
  • Fixed some type hints to use covariant Sequence instead of invariant List (#​2324, #​2325)

v8.10.0: 8.10.0

Compare Source

v8.9.0: 8.9.0

Compare Source

  • Added the cluster.info API
  • Updated the inference_config argument in ml.put_trained_model API to reflect an improvement in the specification

v8.8.2: 8.8.2

Compare Source

Client is compatible with Elasticsearch 8.8.2

v8.8.1: 8.8.1

Compare Source

  • Added the rank parameter in search() endpoint 2d5434f

v8.8.0: 8.8.0

Compare Source

  • Added include_defaults parameter to the cluster.get_component_template, indices.get_data_stream, and indices.get_index_template API
  • Added the indices.delete_data_lifecycle, indices.explain_data_lifecycle, indices.get_data_lifecycle, and indices.put_data_lifecycle APIs
  • Added the experimental search_application.delete, search_application.delete_behavioral_analytics, search_application.get, search_application.get_behavioral_analytics, search_application.list, search_application.put, search_application.put_behavioral_analytics, and search_application.search APIs.

v8.7.0: 8.7.0

Compare Source

  • Added the health_report API
  • Added the transform.schedule_now_transform API
  • Added the from_ request parameter to the transform.start_transform API
  • Added the buffer, grid_agg, and with_labels parameters to the search_mvt API
  • Added the allow_auto_create parameter to the cluster.create_component_template API
  • Added the delete_user_annotations parameter to the ml.delete_job, ml.reset_job API
  • Added the start and end parameters to the ml.preview_datafeed API
  • Added the priority parameter to the ml.start_datafeed API
  • Added the job_id parameter to the ml.update_datafeed API
  • Added the model_prune_window parameter to the ml.update_job API
  • Added the feature_states parameter to the snapshot.restore_snapshot API
  • Added the timeout parameter to the transform.get_transform_stats API
  • Added the from_ parameter to the transform.start_transform API
  • Changed the input parameter of the ml.put_trained_models API from required to optional
  • Fixed the cluster.create_component_template API by removing the erroneously provided aliases, mappings, and settings parameters. Only the template parameter should be used for specifying component templates.

v8.6.2: 8.6.2

Compare Source

  • Client is compatible with Elasticsearch 8.6.2

v8.6.1: 8.6.1

Compare Source

  • Added the expand_wildcards, preference, and routing parameters to the open_point_in_time API.

v8.6.0: 8.6.0

Compare Source

Core

  • Changed the fields parameter of the field_caps API to be encoded in the HTTP request body.
  • Changed the index parameter of the rank_eval API to be optional.
  • Changed the requests parameter of the rank_eval API to be optional.

CAT

  • Added the time parameter to the cat.indices API

Machine Learning

  • Fixed the model_id parameter of the ml.clear_trained_model_deployment_cache API to be required.

v8.5.3: 8.5.3

Compare Source

  • Client is compatible with Elasticsearch 8.5.3

v8.5.2: 8.5.2

Compare Source

  • Client is compatible with Elasticsearch 8.5.2

v8.5.1: 8.5.1

Compare Source

  • Client is compatible with Elasticsearch 8.5.1

v8.5.0: 8.5.0

Compare Source

Indices

  • Added the experimental indices.downsample API.

Rollup

  • Removed the deprecated rollup.rollup API.

Snapshot

  • Added the index_names parameter to the snapshot.get API.

Machine Learning

  • Added the beta ml.clear_trained_model_deployment_cache API.
  • Changed the ml.put_trained_model_definition_part API from experimental to stable.
  • Changed the ml.put_trained_model_vocabulary API from experimental to stable.
  • Changed the ml.start_trained_model_deployment API from experimental to stable.
  • Changed the ml.stop_trained_model_deployment API from experimental to stable.

Security

  • Added the with_limited_by parameter to the get_api_key API.
  • Added the with_limited_by parameter to the query_api_keys API.
  • Added the with_profile_uid parameter to the get_user API.
  • Changed the security.activate_user_profile API from beta to stable.
  • Changed the security.disable_user_profile API from beta to stable.
  • Changed the security.enable_user_profile API from beta to stable.
  • Changed the security.get_user_profile API from beta to stable.
  • Changed the security.suggest_user_profiles API from beta to stable.
  • Changed the security.update_user_profile_data API from beta to stable.
  • Changed the security.has_privileges_user_profile API from experimental to stable.

v8.4.3: 8.4.3

Compare Source

  • Client is compatible with Elasticsearch 8.4.3

v8.4.2: 8.4.2

Compare Source

Documents

  • Added the error_trace, filter_path, human and pretty parameters to the get_source API.
  • Added the ext parameter to the search API.

Async Search

  • Added the ext parameter to the async_search.submit API.

Fleet

  • Added the ext parameter to the fleet.search API.

v8.4.1: 8.4.1

Compare Source

  • Client is compatible with Elasticsearch 8.4.1

v8.4.0: 8.4.0

Compare Source

Documents

  • Added the knn parameter to the search API.
  • Added the knn parameter to the async_search.submit API.

Machine Learning

  • Added the cache_size parameter to the ml.start_trained_model_deployment API.

Security

  • Added the security.update_api_key API.

v8.3.3: 8.3.3

Compare Source

  • Client is compatible with Elasticsearch 8.3.3

v8.3.2: 8.3.2

Compare Source

Security

  • Added the refresh parameter to the security.create_service_token API.

v8.3.1: 8.3.1

Compare Source

Security

  • Added the experimental security.has_privileges_user_profile API
  • Added the hint parameter to the experimental security.suggest_user_profiles API

v8.3.0: 8.3.0

Compare Source

  • Client is compatible with Elasticsearch 8.3.0

v8.2.3: 8.2.3

Compare Source

Documents

  • Added the routing parameter to the msearch API.

CAT

  • Added the cat.component_templates API.

Ingest

  • Added the if_version parameter to the ingest.put_pipeline API.

Security

  • Changed the name parameter for the security.create_service_token API from required to optional.
  • Added the refresh parameter to the security.create_service_token API.
  • Changed the name of access parameter to the labels parameter in the security.update_user_profile_data API.

Shutdown

  • Added the timeout and master_timeout parameters to the shutdown.get_node, shutdown.delete_node, and shutdown.put_node APIs.
  • Added the reason, type, allocation_delay, and target_node_name parameters to the shutdown.put_node API.

v8.2.2: 8.2.2

Compare Source

Client

  • Client is compatible with Elasticsearch 8.2.2

v8.2.1: 8.2.1

Compare Source

Machine Learning

  • Added the inference_config parameter to the ml.infer_trained_model_deployment API.

v8.2.0: 8.2.0

Compare Source

Client

  • Re-introduced support for passing requests.auth.BaseAuth objects to the http_auth parameter which was available in 7.x.

Search

  • Added the filter parameter to the experimental knn_search API

Documents

  • Changed the source and dest parameters for the reindex API from optional to required

Indices

  • Added the indices.field_usage_stats API
  • Added the indices.modify_data_stream API
  • Added the fields and types parameters to the field_caps API
  • Added the ignore_unvailable parameter to the open_point_in_time API
  • Added the master_timeout and timeout parameters to the indices.delete API
  • Added the features parameter to the indices.get API

Machine Learning

  • Added the ml.get_memory_stats API

Migrations

  • Added the migrations.get_feature_upgrade_status API
  • Added the migrations.post_feature_upgrade API

Nodes

  • Added the nodes.clear_repositories_metering_archive API
  • Added the nodes.get_repositories_metering_info API

Security

  • Added the beta security.activate_user_profile API
  • Added the beta security.disable_user_profile API
  • Added the beta security.enable_user_profile API
  • Added the beta security.get_user_profile API
  • Added the beta security.suggest_user_profiles API
  • Added the beta security.update_user_profile_data API

SQL

  • Added the catalog, index_using_frozen, keep_alive, keep_on_completion, runtime_mappings, and wait_for_completion_timeout parameters to the sql.query API

v8.1.3: 8.1.3

Compare Source

Client

  • Client is compatible with Elasticsearch 8.1.3

v8.1.2: 8.1.2

Compare Source

Client

  • Client is compatible with Elasticsearch 8.1.2

v8.1.1: 8.1.1

Compare Source

Documents

  • Changed the source and dest parameters of the reindex API to be required.

Mappings

  • Changed the fields parameter of the field_caps API to be required.

v8.1.0: 8.1.0

Compare Source

Transforms

  • Added the transform.reset_transform API

v8.0.1: 8.0.1

Compare Source

Client

  • Fixed the sort parameter of multiple APIs to serialize in the query string when using the shorthand form

Indices

  • Fixed the index parameter to be required for the indices.field_usage_stats API

SQL

  • Added the catalog, keep_alive, keep_on_completion, params, runtime_mappings, and wait_for_completion_timeout parameters to the sql.query API

v8.0.0: 8.0.0

Compare Source

⚠️ v8.0.0 is a new major release and contains some breaking changes.
For information on how migrate your application from v7.x to v8.0.0 you can read the migration guide here.

Client

Added

  • Added the top-level .options() method to Elasticsearch and AsyncElasticsearch 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 token or service token
  • 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 the transport layer to use the elastic-transport package
  • Changed user-defined body parameters to have semantic names (e.g index(document={...}) instead of index(body={...})).
  • Changed responses to be objects with two properties, meta for response metadata (HTTP status, headers, node, etc) and body for a typed body.
  • Changed AsyncElasticsearch to always be available, regardless of whether aiohttp is installed
  • Changed exception hierarchy, the major change is a new exception ApiError which differentiates between an error that's raised from the transport layer (previously elasticsearch.exceptions.TransportError, now elastic_transport.TransportError) and one raised from the API layer
  • Changed the name of JSONSerializer to JsonSerializer for consistency with other serializer names. Added an alias to the old name for backwards compatibility
  • Changed the default mimetypes (application/json) to instead use compatibility mimetypes (application/vnd.elasticsearch+json) which always request for responses compatibility with version 8.x.

Removed

  • Removed support for Python 2.7 and Python 3.5, the library now supports only Python 3.6+
  • Removed the elasticsearch.connection module as all functionality has been moved

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

@elastic-renovate-prod elastic-renovate-prod bot requested a review from a team as a code owner September 17, 2025 23:55
@elastic-renovate-prod elastic-renovate-prod bot force-pushed the renovate/elasticsearch-9.x branch from bd3c28b to ee30720 Compare September 26, 2025 00:30
@elastic-renovate-prod elastic-renovate-prod bot force-pushed the renovate/elasticsearch-9.x branch from ee30720 to 12c8973 Compare October 28, 2025 20:12
@elastic-renovate-prod elastic-renovate-prod bot force-pushed the renovate/elasticsearch-9.x branch from 12c8973 to 58d7a55 Compare December 23, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant