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), iftrue
, 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