Skip to content

Commit d8a0817

Browse files
committed
[DOCS] Release notes 8.18.0
1 parent 1d11cda commit d8a0817

File tree

3 files changed

+111
-3
lines changed

3 files changed

+111
-3
lines changed

CHANGELOG.md

+55-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,67 @@
11
*See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html*
22

3+
## 8.18.0 Release notes
4+
5+
### API
6+
7+
#### New APIs:
8+
9+
* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results.
10+
* `inference.chat_completion_unified` - Perform chat completion inference
11+
* `inference.completion` - Perform completion inference
12+
* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint
13+
* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint
14+
* `inference.put_anthropic` - Configure an Anthropic inference endpoint
15+
* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint
16+
* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint
17+
* `inference.put_cohere` - Configure a Cohere inference endpoint
18+
* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint
19+
* `inference.put_elser` - Configure an ELSER inference endpoint
20+
* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint
21+
* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint
22+
* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint
23+
* `inference.put_jinaai` - Configure a JinaAI inference endpoint
24+
* `inference.put_mistral` - Configure a Mistral inference endpoint
25+
* `inference.put_openai` - Configure an OpenAI inference endpoint
26+
* `inference.put_voyageai` - Configure a VoyageAI inference endpoint
27+
* `inference.put_watsonx` - Configure a Watsonx inference endpoint
28+
* `inference.rerank` - Perform reranking inference
29+
* `inference.sparse_embedding` - Perform sparse embedding inference
30+
* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference.
31+
* `inference.text_embedding` - Perform text embedding inference
32+
33+
#### Updated APIs:
34+
35+
* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true).
36+
* `cat.segments`
37+
* Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false).
38+
* Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node.
39+
* `cat.tasks`
40+
* Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
41+
* Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed.
42+
* `eql.search`
43+
* Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results.
44+
* Adds Boolean parameter `:allow_partial_sequence_results`, 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.
45+
* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters.
46+
* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter.
47+
* `indices.rollover` - Removes target_failure_store parameter.
48+
* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters.
49+
* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment.
50+
51+
352
## 8.17.2 Release notes
453

554
### API
655

7-
New APIs:
56+
#### New APIs:
57+
858
* `esql.async_query_delete`
959
* `indices.get_data_lifecycle_stats`
1060
* `inference.update`
1161
* `security.delegate_pki`
1262

13-
Updates APIs:
63+
#### Updated APIs:
64+
1465
* `async_search.submit` - Adds `keep_alive` Time parameter.
1566
* `indices.put_template` - Adds `cause` String parameter.
1667
* `xpack.info` - Adds `human` parameter for human-readable information.
@@ -39,7 +90,8 @@ Updates APIs:
3990
* `snapshot_lifecycle_management.get_status` - adds both.
4091
* `snapshot_lifecycle_management.put_lifecycle` - adds both.
4192

42-
APIs promoted from Experimental to Stable:
93+
#### APIs promoted from Experimental to Stable:
94+
4395
* `inference.delete`
4496
* `inference.get`
4597
* `inference.inference`

docs/release_notes/818.asciidoc

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[[release_notes_8_18]]
2+
=== 8.18 Release notes
3+
4+
[discrete]
5+
[[release_notes_8_18_0]]
6+
=== 8.18.0 Release notes
7+
8+
[discrete]
9+
==== API
10+
11+
New APIs:
12+
13+
* `esql.async_query_stop` - Stops a previously submitted async query request given its ID and collects the results.
14+
* `inference.chat_completion_unified` - Perform chat completion inference
15+
* `inference.completion` - Perform completion inference
16+
* `inference.put_alibabacloud` - Configure an AlibabaCloud AI Search inference endpoint
17+
* `inference.put_amazonbedrock` - Configure an Amazon Bedrock inference endpoint
18+
* `inference.put_anthropic` - Configure an Anthropic inference endpoint
19+
* `inference.put_azureaistudio` - Configure an Azure AI Studio inference endpoint
20+
* `inference.put_azureopenai` - Configure an Azure OpenAI inference endpoint
21+
* `inference.put_cohere` - Configure a Cohere inference endpoint
22+
* `inference.put_elasticsearch` - Configure an Elasticsearch inference endpoint
23+
* `inference.put_elser` - Configure an ELSER inference endpoint
24+
* `inference.put_googleaistudio` - Configure a Google AI Studio inference endpoint
25+
* `inference.put_googlevertexai` - Configure a Google Vertex AI inference endpoint
26+
* `inference.put_hugging_face` - Configure a HuggingFace inference endpoint
27+
* `inference.put_jinaai` - Configure a JinaAI inference endpoint
28+
* `inference.put_mistral` - Configure a Mistral inference endpoint
29+
* `inference.put_openai` - Configure an OpenAI inference endpoint
30+
* `inference.put_voyageai` - Configure a VoyageAI inference endpoint
31+
* `inference.put_watsonx` - Configure a Watsonx inference endpoint
32+
* `inference.rerank` - Perform reranking inference
33+
* `inference.sparse_embedding` - Perform sparse embedding inference
34+
* `inference.stream_inference` renamed to `inference.stream_completion` - Perform streaming completion inference.
35+
* `inference.text_embedding` - Perform text embedding inference
36+
37+
38+
Updated APIs:
39+
40+
* `bulk`, `create`, `index`, `update` - Add Boolean parameter `:include_source_on_error`, if to include the document source in the error message in case of parsing errors (defaults to true).
41+
* `cat.segments`
42+
** Adds Boolean parameter `:local`, return local information, do not retrieve the state from master node (default: false).
43+
** Adds Time parameter `:master_timeout`, explicit operation timeout for connection to master node.
44+
* `cat.tasks`
45+
** Adds Time parameter `:timeout`, period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
46+
** Adds Boolean parameter `:wait_for_completion`, if `true`, the request blocks until the task has completed.
47+
* `eql.search`
48+
** Adds Boolean parameter `:allow_partial_search_results`, control whether the query should keep running in case of shard failures, and return partial results.
49+
** Adds Boolean parameter `:allow_partial_sequence_results`, 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.
50+
* `index_lifecycle_management.delete_lifecycle`, `index_lifecycle_management.explain_lifecycle`, `index_lifecycle_management.get_lifecycle`, `index_lifecycle_management.put_lifecycle`, `index_lifecycle_management.start`, `index_lifecycle_management.stop`, remove `:master_timeout`, `:timeout` parameters.
51+
* `indices.resolve_cluster` - Adds `:timeout` parameter, `:name` no longer a required parameter.
52+
* `indices.rollover` - Removes target_failure_store parameter.
53+
* `ingest.delete_geoip_database`, `ingest.delete_ip_location_database`, `put_geoip_database`, `put_ip_location_database` remove `:master_timeout`, `:timeout` parameters.
54+
* `machine_learning.start_trained_model_deployment` - Adds body request parameter, the settings for the trained model deployment.

docs/release_notes/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
[discrete]
55
=== 8.x
6+
* <<release_notes_8_18, 8.18 Release Notes>>
67
* <<release_notes_8_17, 8.17 Release Notes>>
78
* <<release_notes_8_16, 8.16 Release Notes>>
89
* <<release_notes_8_15, 8.15 Release Notes>>
@@ -39,6 +40,7 @@
3940
* <<release_notes_75, 7.5 Release Notes>>
4041
* <<release_notes_70, 7.0 Release Notes>>
4142

43+
include::818.asciidoc[]
4244
include::817.asciidoc[]
4345
include::816.asciidoc[]
4446
include::815.asciidoc[]

0 commit comments

Comments
 (0)