Official PHP client for Elasticsearch.
This release is compatible with the latest Elasticsearch 8.13.0.
mapTo($class)
function to Elasticsearch response for mapping the result of ES|QL
query to an object of stdClass or of a specific class #1398
This release introduces 6 new APIs and 6 EXPERIMENTAL APIs.
AsyncSearch.status
keep_alive
parameter (time), specify the time interval in which the results (partial or final) for this search will be available.Connector.list
index_name
: list, a comma-separated list of connector index names to fetch connector documents for;connector_name
: list, a comma-separated list of connector names to fetch connector documents for;service_type
: list, a comma-separated list of connector service types to fetch connector documents for;query
: string, a search string for querying connectors, filtering results by matching against connector names, descriptions, and index names;Connector.updateApiKeyId
(new EXPERIMENTAL API)
Connector.updateIndexName
(new EXPERIMENTAL API)
Connector.updateNative
(new EXPERIMENTAL API)
Connector.updateServiceType
(new EXPERIMENTAL API)
Connector.updateStatus
(new EXPERIMENTAL API)
ConnectorSyncJob.list
job_type
parameter (list), a comma-separated list of job types.Esql.asyncQuery
(new EXPERIMENTAL API)
Esql.asyncQueryGet
(new API)
Esql.query
drop_null_columns
parameter (boolean) to sepcify if null columns should be removed from the results. If yes, their name and type will be returned in a new all_columns
section.Indices.resolveCluster
(new API)
Indices.rollover
lazy
parameter (boolean), if set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.Inference.deleteModel
model_id
parameter has been renamed to inference_id
.Inference.getModel
model_id
parameter has been renamed in inference_id
.Inference.inference
model_id
parameter has been renamed in inference_id
.Inference.putModel
model_id
parameter has been renamed in inference_id
.Profiling.flamegraph
(new API)
Profiling.stacktraces
(new API)
Security.queryUser
(new API)
Synonyms.deleteSynonym
Synonyms.deleteSynonymRule
Synonyms.getSynonym
Synonyms.getSynonymRule
Synonyms.getSynonymsSets
Synonyms.putSynonym
Synonyms.putSynonymRule
TextStructure.testGrokPattern
(new API)
This release is compatible with the latest Elasticsearch 8.12.0.
This release has been tested with PHP 8.3, released on Nov 23, 2023.
bulk
list_executed_pipelines
boolean parameter. Sets list_executed_pipelines
for all incoming documents. Defaults to unset (false).indices.put_settings
reopen
boolean parameter. Whether to close and reopen the index to apply non-dynamic settings. If set to true
the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is false
.open_point_in_time
body
object/Hash parameter. An index_filter specified with the Query DSL.security.get_api_key
active_only
boolean parameter. Flag to limit response to only active (not invalidated or expired) API keys.profiling.status
(new API)
simulate.ingest
(new EXPERIMENTAL API)
connector.post
(new EXPERIMENTAL API)
connector.put
(new EXPERIMENTAL API)
connector.delete
(new EXPERIMENTAL API)
connector.get
(new EXPERIMENTAL API)
connector.list
(new EXPERIMENTAL API)
connector.check_in
(new EXPERIMENTAL API)
connector.update_configuration
(new EXPERIMENTAL API)
connector.update_error
(new EXPERIMENTAL API)
connector.update_filtering
(new EXPERIMENTAL API)
connector.last_sync
(new EXPERIMENTAL API)
connector.update_name
(new EXPERIMENTAL API)
connector.update_pipeline
(new EXPERIMENTAL API)
connector.update_scheduling
(new EXPERIMENTAL API)
connector_sync_job.cancel
(new EXPERIMENTAL API)
connector_sync_job.check_in
(new EXPERIMENTAL API)
connector_sync_job.delete
(new EXPERIMENTAL API)
connector_sync_job.error
(new EXPERIMENTAL API)
connector_sync_job.get
(new EXPERIMENTAL API)
connector_sync_job.list
(new EXPERIMENTAL API)
connector_sync_job.post
(new EXPERIMENTAL API)
connector_sync_job.update_stats
(new EXPERIMENTAL API)
This release is compatible with the latest Elasticsearch 8.11.0.
It includes the following fix:
API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html
API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.delete_model.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html
API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.get_model.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html
API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.inference.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html
API: https://github.com/elastic/elasticsearch/blob/v8.11.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_model.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html
This release is compatible with the latest Elasticsearch 8.10.0.
Added 10 new APIs: 8 EXPERIMENTAL and 2 stable:
QueryRuleset.list
(new EXPERIMENTAL API)
Security.getSettings
(new API)
Security.updateSettings
(new API)
Synonyms.delete
deleteSynonym
.Synonyms.deleteSynonym
(new EXPERIMENTAL API)
Synonyms.delete
. Removed synonyms_set
in favor of id
parameter (string). The id of the synonyms set to be deleted.Synonyms.deleteSynonymRule
(new EXPERIMENTAL API)
Synonyms.get
getSynonym
.Synonyms.getSynonym
(new EXPERIMENTAL API)
Synonyms.getSynonym
. Removed synonyms_set
in favor of id
required parameter (string). The name of the synonyms set to be retrieved.Synonyms.getSynonymRule
(new EXPERIMENTAL API)
Synonyms.getSynonymsSets
(new EXPERIMENTAL API)
Synonyms.put
putSynonym
.Synonyms.putSynonym
(new EXPERIMENTAL API)
Synonyms.put
. Removed synonyms_set
in favor of id
required parameter (string). The id of the synonyms set to be created or updated.Synonyms.putSynonymRule
(new EXPERIMENTAL API)
This release is compatible with the latest Elasticsearch 8.9.0.
Cluster.info
(new API)
QueryRuleset.delete
(new EXPERIMENTAL API)
QueryRuleset.get
(new EXPERIMENTAL API)
QueryRuleset.put
(new EXPERIMENTAL API)
SearchApplication.renderQuery
(new EXPERIMENTAL API)
Security.createCrossClusterApiKey
(new EXPERIMENTAL API)
Security.updateCrossClusterApiKey
(new EXPERIMENTAL API)
SynonymRule.put
(new EXPERIMENTAL API)
Synonyms.delete
(new EXPERIMENTAL API)
Synonyms.get
(new EXPERIMENTAL API)
Synonyms.put
(new EXPERIMENTAL API)
SynonymsSets.get
(new EXPERIMENTAL API)
This release contains the following fix:
psr/http-message
^2.0 support #1313 (this was supposed to be in 8.8.0)This release is compatible with the latest Elasticsearch 8.8.0.
This release introduces 15 new APIs: 13 EXPERIMENTAL and 2 stable.
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)
Added include_defaults
boolean parameters. Return all default configurations
for the component template (default: false)
API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_lifecycle.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-delete-lifecycle.html
API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.explain_data_lifecycle.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/dlm-explain-lifecycle.html
API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_lifecycle.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/dlm-get-lifecycle.html
Added include_defaults
boolean parameter. Return all relevant default configurations
for the data stream (default: false)
Added include_defaults
boolean parameter. Return all relevant default configurations
for the index template (default: false)
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
Added include_defaults
boolean parameter. Return all relevant default configurations
for this index template simulation (default: false)
Added include_defaults
boolean parameter. Return all relevant default configurations
for this template simulation (default: false)
Make id
parameter optional.
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
Added deployment_id
string parameter. The Id of the new deployment. Defaults to the
model_id if not set.
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
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
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
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
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
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
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
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
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
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.
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
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
This release is compatible with the latest Elasticsearch 8.7.0.
php-http/discovery
library #1294
This release introduces 2 new APIs.
API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/health_report.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html
API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/transform.schedule_now_transform.json Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html
Added the delete_user_annotations
boolean parameter. Should annotations added by the user be deleted
Added the delete_user_annotations
boolean parameter. Should annotations added by the user be deleted
Added the timeout
time parameter. Controls the time to wait for the stats
Added the from
string parameter. Restricts the set of transformed entities to those changed after this time