Changelog History
Page 1
-
v8.5.2 Changes
๐ API Bugfix
Fixes
security.create_service_token
API, usesPOST
when token name isn't present. ๐ Thanks @carlosdelest for reporting in #1961. -
v8.5.1 Changes
๐ Bugfix
Fixes bug when instantiating client with
api_key
: When passing inapi_key
andtransport_options
that don't include headers to the client, theapi_key
code would overwrite the arguments passed in fortransport_options
. This was fixed in this Pull Request. ๐ Thanks svdasein for reporting in #1940. -
v8.5.0 Changes
- โ Tested versions of Ruby for 8.5.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
Client
๐ With the latest release of
elastic-transport
-v8.1.0
- this gem now supports Faraday v2. Elasticsearch Ruby has an open dependency onelastic-transport
('elastic-transport', '~> 8'
), so when you upgrade your gems,8.1.0
will be installed. This supports both Faraday v1 and Faraday v2. The main change on dependencies when using Faraday v2 is all adapters, except for the defaultnet_http
one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile.These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:
-
v8.4.0 Changes
- โ Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
API
๐ New APIs
security.update_api_key
- Updates attributes of an existing API key. Documentation.
API Changes
get
- Adds new parameterforce_synthetic_source
(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.machine_learning.start_trained_model_deployment
- Adds new parametercache_size
(String) A byte-size value for configuring the inference cache size. For example, 20mb.mget
- Adds new parameterforce_synthetic_source
(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
- Adds new parameterforce_synthetic_source
(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.snapshot.get
- Adds new parameters:sort
(String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count).size
(Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit.order
(String) Sort order (options: asc, desc).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.
-
v8.3.0 Changes
- โ Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
API
- โ Added build hash to auto generated code. The code generator obtains the git hash from the Elasticsearch specification and adds it as a comment in the code. This allows us to track the version for each generated class.
- โก๏ธ Updated for compatibility with Elasticsearch 8.3's API.
API Changes
cluster.delete_voting_config_exclusions
,cluster.post_voting_config_exclusions
- Add new parametermaster_timeout
(Time) Timeout for submitting request to master.machine_learning.infer_trained_model_deployment
is renamed tomachine_learning.infer_trained_model
. The url/_ml/trained_models/{model_id}/deployment/_infer
is deprecated since 8.3, use/_ml/trained_models/{model_id}/_infer
instead.machine_learning.preview_datafeed
- Adds new parameters:start
(String) The start time from where the datafeed preview should beginend
(String) The end time when the datafeed preview should stop
machine_learning.start_trained_model_deployment
- Adds new parameters:number_of_allocations
(Integer) The number of model allocations on each node where the model is deployed.threads_per_allocation
(Integer) The number of threads used by each model allocation during inference.queue_capacity
(Integer) Controls how many inference requests are allowed in the queue at a time.
search_mvt
- Adds new parameter:with_labels
(Boolean) If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features- 0๏ธโฃ
snapshot.get
- Adds new parameter:index_names
(Boolean) Whether to include the name of each index in the snapshot. Defaults to true.
๐ New Experimental APIs
security.has_privileges_user_profile
Determines whether the users associated with the specified profile IDs have all the requested privileges
-
v8.2.2 Changes
- โก๏ธ Updates dependency on
elastic-transport
to~> 8.0
- โก๏ธ Updates dependency on
-
v8.2.1 Changes
๐ No release, no changes on the client.
-
v8.2.0 Changes
- โ Tested versions of Ruby for 8.2.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
API
โก๏ธ Updated for compatibility with Elasticsearch 8.2's API.
๐ New parameters:
field_caps
filters
An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parenttypes
Only return results for fields that have one of the types in the list
๐ New APIs:
cat.component_templates
- Returns information about existing component_templates templates.ml.get_memory_stats
- Returns information on how ML is using memory.
๐ New Experimental APIs:
- ๐
security.activate_user_profile
- Creates or updates the user profile on behalf of another user. - ๐
security.disable_user_profile
- Disables a user profile so it's not visible in user profile searches. - ๐
security.enable_user_profile
- Enables a user profile so it's visible in user profile searches. - ๐
security.get_user_profile
- Retrieves a user profile for the given unique ID. - ๐
security.suggest_user_profiles
- Get suggestions for user profiles that match specified search criteria. - ๐
security.update_user_profile_data
- Update application specific data for the user profile of the given unique ID.
-
v8.1.2 Changes
API
- ๐ Fixes an issue with the generated API code. When updating the code generator for 8.x, the order of
arguments.clone
in the generated code was changed. This would make it so that we would modify the parameters passed in before cloning them, which is undesired. Issue: #1727.
- ๐ Fixes an issue with the generated API code. When updating the code generator for 8.x, the order of
-
v8.1.1 Changes
๐ No release, no changes on the client.