Elasticsearch Php Versions Save

This release is compatible with the latest Elasticsearch 8.6.0.

General changes

This release introduces 1 new API.

Specific changes per endpoints

Ml.startTrainedModelDeployment

Added the priority string paramter. The deployment priority.

Ml.updateTrainedModelDeployment (new API)

API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/ml.update_trained_model_deployment.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html

This release is compatible with the latest Elasticsearch 8.5.0.

General changes

This release introduces 1 experimental new API and 2 stable APIs.

Specific changes per endpoints

Indices.downsample (new EXPERIMENTAL API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/indices.downsample.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html

Ml.clearTrainedModelDeploymentCache (new API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/ml.clear_trained_model_deployment_cache.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html

Ml.inferTrainedModel

This API is now stable.

Ml.putTrainedModelDefinitionPart

This API is now stable.

Ml.putTrainedModelVocabulary

This API is now stable.

Ml.startTrainedModelDeployment

This API is now stable. The descript of the number_of_allocations has been changed in "The total number of allocations this model is assigned across machine learning nodes".

Ml.stopTrainedModelDeployment

This API is now stable.

Rollup.rollup

This experimental API has been removed.

Security.activateUserProfile

This API is now stable.

Security.bulkUpdateApiKeys (new API)

API: https://github.com/elastic/elasticsearch/blob/8.5/rest-api-spec/src/main/resources/rest-api-spec/api/security.bulk_update_api_keys.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html

Security.disableUserProfile

This API is now stable.

Security.enableUserProfile

This API is now stable.

Security.getApiKey

Added the with_limited_by boolean parameter. Flag to show the limited-by role descriptors of API Keys.

Security.getUser

Added the with_profile_uid boolean parameter. Flag to retrieve profile uid (if exists) associated to the user.

Security.getUserProfile

This API is now stable. Changed the description of uid parameter, a comma-separated list of unique identifier for user profiles.

Security.hasPrivilegesUserProfile

This API is now stable.

Security.queryApiKeys

Added the with_limited_by boolean parameter. Flag to show the limited-by role descriptors of API Keys.

Security.suggestUserProfiles

This API is now stable.

Security.updateUserProfileData

This API is now stable.

TextStructure.findStructure

Added the ecs_compatibility string parameter. Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'.

This release contains the following fix:

• Fixed a node selector issue for StickyRoundRobinSelector #1253

This release is compatible with the latest Elasticsearch 8.4.0 and includes the following changes:

• Added a ClientInterface to simplify the mock of the Client, this is a fix for #1227 #1249
• Added the support of Symfony HTTP client, fixing the issue #1241 #1243
• Added the API compatibility header #1233

Added the following new API 🎉

Stable

• Security.updateApiKey: api spec, documentation

API changes

get

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

mget

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

search

Added the force_synthetic_source parameter (boolean). Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.

Ml.startTrainedModelDeployment

Added cache_size parameter (string). A byte-size value for configuring the inference cache size. For example, 20mb.

Snapshot.get

Added the following parameters:

• sort (enum), allows setting a sort order for the result. Defaults to start_time;
• size (integer), maximum number of snapshots to return. Defaults to 0 which means return all that match without limit;
• order (enum), soprt order;
• from_sort_value (string), value of the current sort column at which to start retrieval;
• after (string), offset identifier to start pagination from as returned by the 'next' field in the response body;
• offset (integer), numeric offset to start pagination based on the snapshots matching the request. Defaults to 0;
• slm_policy_filter (string), filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy.

This release is compatible with the latest Elasticsearch 8.3.0.

Added the following new API 🎉

Experimental

• Security.hasPrivilegesUserProfile: api spec, documentation

API changes

Cluster.deleteVotingConfigExclusions

Added master_timeout parameter (time). Timeout for submitting request to master.

Cluster.postVotingConfigExclusions

Added master_timeout parameter (time). Timeout for submitting request to master.

Ml.inferTrainedModel (renamed)

The Ml.inferTrainedModelDeployment API has been renamed in Ml.inferTrainedModel.

Ml.previewDatafeed

Added the following optional parameters:

• start: string, the start time from where the datafeed preview should begin;
• end: string, the end time when the datafeed preview should stop.

Ml.startTrainedModelDeployment

Added the following optional parameters:

• number_of_allocations: int, the number of model allocations on each node where the model is deployed;
• threads_per_allocation: int, the number of threads used by each model allocation during inference;
• queue_capacity: int, controls how many inference requests are allowed in the queue at a time.

Snapshot.get

Added the index_names parameter (boolean). Whether to include the name of each index in the snapshot. Defaults to true.

This release is compatible with the latest Elasticsearch 8.2.1.

This release is compatible with the latest Elasticsearch 8.2.0.

This release includes the following fixes:

• Added the array support for text/plain #1220

Added the following new APIs 🎉 (2 stable and 6 experimental)

Stable

• Cat.componentTemplates: api spec, documentation
• Ml.getMemoryStats: api spec, documentation

Experimental

• Security.activateUserProfile: api spec, documentation
• Security.disableUserProfile: api spec, documentation
• Security.enableUserProfile: api spec, documentation
• Security.getUserProfile: api spec, documentation
• Security.suggestUserProfiles: api spec, documentation
• Security.updateUserProfileData: api spec, documentation

This release is compatible with the latest Elasticsearch 8.1.0.

Added the following new APIs 🎉 (4 stable)

• Security.oidcAuthenticate: api spec, documentation
• Security.oidcLogout : api spec, documentation
• Security.oidcPrepareAuthentication : api spec, documentation
• Transform.resetTransform : api spec, documentation

API changes

Indices.forcemerge

Added wait_for_completion parameter.

Indices.get

Added features enum parameter, return only information on specified index features.

Ml.deleteTrainedModel

Added force boolean parameter, true if the model should be forcefully deleted.

This release contains the following fix:

• use of NoNodeAvailableException exception in endpoints, fixing https://github.com/elastic/elasticsearch-php/issues/1209 with e7d448d

Finally 8.0.0 for Elasticsearch 8.0 is GA!!! :partying_face:

This new major version of elasticsearch-php contains a brand new implementation compared with 7.x. It supports PSR-7 for HTTP messages and PSR-18 for HTTP client communications. We used the elastic-transport-php library for HTTP communications.

We tried to reduce the BC breaks as much as possible with 7.x but there are some (big) differences:

• we changed the namespace, now everything is under Elastic\Elasticsearch;
• we changed the Exception model, using the namespace Elastic\Elasticsearch\Exception. All the exceptions extends the ElasticsearchException interface, as in 7.x;
• we changed the response type of each endpoints using an Elasticsearch response class. This class wraps a a PSR-7 response allowing the access of the body response as array or object. This means you can access the API response as in 7.x, no BC break here! :angel:

You can have a look at the BREAKING_CHANGES file for more information.

We are still working on the new documentation for 8.0, in the meantime you can have a look at the README where we reported a quick start guide.