Release 8.18.0

This version includes the API changes in Elasticsearch 8.18.0.

General changes

This release introduces 23 new APIs.

Specific changes per endpoints

bulk

• Added the include_source_on_error parameter (boolean), true or false if to include the document source in the error message in case of parsing errors. Defaults to true.

create

• Added the include_source_on_error parameter (boolean), true or false if to include the document source in the error message in case of parsing errors. Defaults to true.

index

• Added the include_source_on_error parameter (boolean), true or false if to include the document source in the error message in case of parsing errors. Defaults to true.

update

• Added the include_source_on_error parameter (boolean), true or false if to include the document source in the error message in case of parsing errors. Defaults to true.

Cat.segments

• Added the local parameter (boolean), return local information, do not retrieve the state from master node (default: false)
• Added the master_timeout parameter (int|string), explicit operation timeout for connection to master node

Cat.tasks

• Added the timeout parameter (int|string), period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error
• Added the wait_for_completion parameter (boolean), if true, the request blocks until the task has completed

Eql.search

• Added the allow_partial_search_results parameter (boolean), control whether the query should keep running in case of shard failures, and return partial results
• Added the allow_partial_sequence_results parameter (boolean), control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true

Esql.asyncQueryStop (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_stop.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-stop-api.html

Indices.putTemplate

• Added the cause parameter (string), user defined reason for creating/updating the index template

Indices.resolveCluster

• The name parameter is not mandatory anymore
• Added the timeout parameter (int|string), the maximum time to wait for remote clusters to respond

Inference.chatCompletionUnified (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.chat_completion_unified.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/chat-completion-inference.html

Inference.completion (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.completion.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html

Inference.delete

This endpoint is not EXPERIMENTAL anymore

Inference.get

This endpoint is not EXPERIMENTAL anymore

Inference.inference

This endpoint is not EXPERIMENTAL anymore

Inference.put

This endpoint is not EXPERIMENTAL anymore

Inference.putAlibabacloud (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_alibabacloud.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html

Inference.putAmazonbedrock (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_amazonbedrock.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html

Inference.putAnthropic (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_anthropic.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-anthropic.html

Inference.putAzureaistudio (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_azureaistudio.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html

Inference.putAzureopenai (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_azureopenai.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html

Inference.putCohere (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_cohere.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html

Inference.putElasticsearch (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_elasticsearch.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html

Inference.putElser (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_elser.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elser.html

Inference.putGoogleaistudio (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_googleaistudio.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-ai-studio.html

Inference.putGooglevertexai (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_googlevertexai.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-vertex-ai.html

Inference.putHuggingFace (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_hugging_face.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html

Inference.putJinaai (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_jinaai.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html

Inference.putMistral (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_mistral.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-mistral.html

Inference.putOpenai (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_openai.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-openai.html

Inference.putVoyageai (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_voyageai.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html

Inference.putWatsonx (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_watsonx.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-watsonx-ai.html

Inference.rerank (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.rerank.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html

Inference.sparseEmbedding (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.sparse_embedding.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html

Inference.streamCompletion (new API)

This endpoint replaces the Inference.streamInterface.
API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.stream_completion.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html

Inference.streamInferface

This endpoint has been removed

Inference.textEmbedding (new API)

API: https://github.com/elastic/elasticsearch/blob/v8.18.0/rest-api-spec/src/main/resources/rest-api-spec/api/inference.text_embedding.json
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html

Release 9.0.0

This is the new major release of elasticsearch-php compatible with Elasticsearch 9.0.0 🎉

• Compatibility with Elasticsearch 9.0: All changes and additions to Elasticsearch APIs for its 9.0 release are reflected in this release.
• Serverless client merged in: the elastic/elasticsearch-serverless client is being deprecated, and its functionality has been merged back into this client. This should have zero impact on the way the client works by default. If an endpoint is available in serverless, the PHP function will contains a @group serverless phpdoc attribute.
  If you try to use an endpoint that is not available in serverless you will get a 410 HTTP error with a message as follows:
  "this endpoint exists but is not available when running in serverless mode".
  The 9.0.0 client can recognize that it is communicating with a serverless instance if you are using a URL managed by Elastic (e.g. *.elastic.cloud).
  If you are using a proxy, the client will be able to recognize that the host is serverless from the first response. Alternatively, you can explicitly indicate that the host is serverless using the Client::setServerless(true) function (false by default).
• New transport library with PSR-18 cURL client as default: we've removed the Guzzle dependency from the client. By default, the built-in cURL-based HTTP client will be used if no other PSR-18 compatible clients are detected. See release 9.0.0 of elastic-transport-php.

Breaking changes

• Use of PHP 8.1+: Starting from 9.0.0 the elasticsearch-php client requires PHP 8.1+.

Deprecations

• Utility::urlencode(): this function has been deprecated in favor of rawurlencode() of PHP (see #1278).

Release 8.17.1

This release contains the following fix:

• Fix and improvements for PHPStan (rule level 5) #1442 (thanks @AJenbo)

Release 6.8.4

This release fixes the following issues:

• Upgrade ezimuel/ringphp to 1.3.0 to support React Promise v3 for Elasticsearch #1430
• Fixed implicitly nullable parameters being deprecated in PHP 8.4 notice issue #1420

Thanks to @MaelitoP and @dakujem for these fixes.

Release 8.17.0

• Updated the APIs to Elasticsearch 8.17.0

Release 8.16.0

• Updated the APIs to Elasticsearch 8.16.0
• Added the support of PHP 8.4 #1415 (thanks @ruudk)

Release 8.15.0

• Updated the APIs to Elasticsearch 8.15.0
• Added the support of OpenTelemetry

Read the elastic-transport-php README for more information about OpenTelemetry support.

Release 8.14.0

This release is compatible with the latest Elasticsearch 8.14.0.

This release introduces 3 new APIs and 10 EXPERIMENTAL APIs.

• Specific changes per endpoints
  • Ccr.deleteAutoFollowPattern
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.follow
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.followInfo
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.followStats
    • Added the timeout parameter (time), explicit operation timeout.
  • Ccr.forgetFollower
    • Added the timeout parameter (time), explicit operation timeout.
  • Ccr.getAutoFollowPattern
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.pauseFollow
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.putAutoFollowPattern
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.resumeAutoFollowPattern
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.resumeFollow
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.stats
    • Added the timeout parameter (time), explicit operation timeout.
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • Ccr.unfollow
    • Added the master_timeout parameter (time), explicit operation timeout for connection to master node.
  • ConnectorSyncJob
    • The APIs of ConnectorSyncJob has been removed and merged in Connector namespace.
  • Connector.delete
    • Added the delete_sync_jobs parameter (boolean), determines whether associated sync jobs are also deleted.
  • Connector.syncJobCancel (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_cancel.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html
  • Connector.syncJobCheckIn (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_check_in.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html
  • Connector.syncJobDelete (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_delete.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html
  • Connector.syncJobError (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_error.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html
  • Connector.syncJobGet (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_get.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html
  • Connector.syncJobList (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_list.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html
  • Connector.syncJobPost (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_post.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html
  • Connector.syncJobUpdateStats (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.sync_job_update_stats.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html
  • Connector.updateActiveFiltering (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_active_filtering.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html
  • Connector.updateFilteringValidation (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_filtering_validation.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html
  • Esql.asyncQuery
    • This API is now stable.
  • Esql.query
    • This API is now stable.
  • Indices.rollover
    • Added the target_failure_store parameter (boolean), if set to true, the rollover action will be applied on the failure store of the data stream.
  • Inference.getModel
    • The inference_id is not anymore a required parameter.
  • Profiling.topnFunctions (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/profiling.topn_functions.json
    • Documentation: https://www.elastic.co/guide/en/observability/current/universal-profiling.html
  • SearchApplication.search
    • Added the typed_keys parameter (boolean), specify whether aggregation and suggester names should be prefixed by their respective types in the response.
  • Security.getApiKey
    • Added the with_profile_uid parameter (boolean), flag to also retrieve the API Key's owner profile uid, if it exists.
  • Security.queryApiKeys
    • Added the with_profile_uid parameter (boolean), flag to also retrieve the API Key's owner profile uid, if it exists.
    • Added the typed_keys paremeter (boolean), flag to prefix aggregation names by their respective types in the response.
  • TextStructure.findFieldStructure (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_field_structure.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html
  • TextStructure.findMessageStructure (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.find_message_structure.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html

Release 6.8.3

This release contains the following fixes:

• Allow PSR/2 #1154
• Removed PHP 8 deprecation notice 3d2d852

Release 8.13.0

This release is compatible with the latest Elasticsearch 8.13.0.

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

• Specific changes per endpoints
  • AsyncSearch.status
    • Added the keep_alive parameter (time), specify the time interval in which the results (partial or final) for this search will be available.
  • Connector.list
    • Added the following parameters:
      • 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)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_api_key_id.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html
  • Connector.updateIndexName (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_index_name.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-index-name-api.html
  • Connector.updateNative (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_native.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html
  • Connector.updateServiceType (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_service_type.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-service-type-api.html
  • Connector.updateStatus (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/connector.update_status.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-status-api.html
  • ConnectorSyncJob.list
    • Added the job_type parameter (list), a comma-separated list of job types.
  • Esql.asyncQuery (new EXPERIMENTAL API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html
  • Esql.asyncQueryGet (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/esql.async_query_get.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html
  • Esql.query
    • Added the 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)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/get_script.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html
  • Indices.rollover
    • Added the 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
    • The model_id parameter has been renamed to inference_id.
  • Inference.getModel
    • The model_id parameter has been renamed in inference_id.
  • Inference.inference
    • The model_id parameter has been renamed in inference_id.
  • Inference.putModel
    • The model_id parameter has been renamed in inference_id.
  • Profiling.flamegraph (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/profiling.flamegraph.json
    • Documentation: https://www.elastic.co/guide/en/observability/current/universal-profiling.html
  • Profiling.stacktraces (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/profiling.stacktraces.json
    • Documentation: https://www.elastic.co/guide/en/observability/current/universal-profiling.html
  • Security.queryUser (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/security.query_user.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html
  • Synonyms.deleteSynonym
    • This API is now stable.
  • Synonyms.deleteSynonymRule
    • This API is now stable.
  • Synonyms.getSynonym
    • This API is now stable.
  • Synonyms.getSynonymRule
    • This API is now stable.
  • Synonyms.getSynonymsSets
    • This API is now stable.
  • Synonyms.putSynonym
    • This API is now stable.
  • Synonyms.putSynonymRule
    • This API is now stable.
  • TextStructure.testGrokPattern (new API)
    • API: https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/text_structure.test_grok_pattern.json
    • Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html