elastic/elasticsearch-php v8.8.0 on GitHub

This release is compatible with the latest Elasticsearch 8.8.0.

SearchHitIterators and SearchResponseIterator helpers revised with new version #1302

General changes

This release introduces 15 new APIs: 13 EXPERIMENTAL and 2 stable.

Specific changes per endpoints

search

Added the include_named_queries_score boolean parameter. Indicates whether hit.matched_queries
should be rendered as a map that includes the name of the matched query associated with its score
(true) or as an array containing the name of the matched queries (false)

Cluster.getComponentTemplate

Added include_defaults boolean parameters. Return all default configurations
for the component template (default: false)

Indices.getDataStream

Added include_defaults boolean parameter. Return all relevant default configurations
for the data stream (default: false)

Indices.getIndexTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for the index template (default: false)

Indices.putDataLifecycle (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_lifecycle.json
DOcumentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-put-lifecycle.html

Indices.simulateIndexTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for this index template simulation (default: false)

Indices.simulateTemplate

Added include_defaults boolean parameter. Return all relevant default configurations
for this template simulation (default: false)

Logstash.getPipeline

Make id parameter optional.

Ml.putTrainedModel

Added wait_for_completion boolean parameter. Whether to wait for all child operations
(e.g. model download) to complete, before returning or not. Default to false

Ml.startTrainedModelDeployment

Added deployment_id string parameter. The Id of the new deployment. Defaults to the
model_id if not set.

SearchApplication.delete (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html

SearchApplication.deleteBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html

SearchApplication.get (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.get.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html

SearchApplication.getBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.get_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html

SearchApplication.list (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.list.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html

SearchApplication.postBehavioralAnalyticsEvent (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.post_behavioral_analytics_event.json
Documentation: TBD

SearchApplication.put (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html

SearchApplication.putBehavioralAnalytics (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put_behavioral_analytics.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html

SearchApplication.search (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/search_application.search.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html

Transform.deleteTransform

Added delete_dest_index boolean parameter. When true, the destination index is deleted together
with the transform. The default value is false, meaning that the destination index will not be deleted.

Watcher.getSettings (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.get_settings.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html

Watcher.updateSettings (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/watcher.update_settings.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html

elastic/elasticsearch-php v8.8.0 Release 8.8.0 on GitHub