NAME
OpenSearch::Client::Core::3_0::Direct::LTR
VERSION
version 3.007002
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->ltr-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Learning to Rank
The Learning to Rank plugin for OpenSearch enables you to use machine learning (ML) and behavioral data to fine-tune the relevance of documents. It uses models from the XGBoost and RankLib libraries. These models rescore the search results, considering query-dependent features such as click-through data or field matches, which can further improve relevance.
See OpenSearch documentation for ltr.
METHODS
ltr->add_features_to_set
Add features to an existing feature set in the default feature store.
Paths served by this method:
$resp = $client->ltr->add_features_to_set(
'body' => $body, # optional
# path parameters
'name' => $name, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'merge' => $qval1, # boolean
'routing' => $qval2, # string
'version' => $qval3, # number
# Common API query string parameters
'error_trace' => $qval4, # boolean
'filter_path' => $qval5, # list
'human' => $qval6, # boolean
'pretty' => $qval7, # boolean
'source' => $qval8, # string
);OpenSearch documentation for ltr.add_features_to_set
ltr->add_features_to_set_by_query
Add features to an existing feature set in the default feature store.
Paths served by this method:
POST /_ltr/_featureset/{name}/_addfeatures/{query}POST /_ltr/{store}/_featureset/{name}/_addfeatures/{query}
$resp = $client->ltr->add_features_to_set_by_query(
# path parameters
'name' => $name, # required
'query' => $query, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'merge' => $qval1, # boolean
'routing' => $qval2, # string
'version' => $qval3, # number
# Common API query string parameters
'error_trace' => $qval4, # boolean
'filter_path' => $qval5, # list
'human' => $qval6, # boolean
'pretty' => $qval7, # boolean
'source' => $qval8, # string
);OpenSearch documentation for ltr.add_features_to_set_by_query
ltr->cache_stats
Retrieves cache statistics for all feature stores.
Paths served by this method:
$resp = $client->ltr->cache_stats(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.cache_stats
ltr->clear_cache
Clears the store caches.
Paths served by this method:
$resp = $client->ltr->clear_cache(
# path parameters
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.clear_cache
ltr->create_default_store
Creates the default feature store.
Paths served by this method:
$resp = $client->ltr->create_default_store(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.create_default_store
ltr->create_feature
Create or update a feature in the default feature store.
Paths served by this method:
$resp = $client->ltr->create_feature(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.create_feature
ltr->create_featureset
Create or update a feature set in the default feature store.
Paths served by this method:
$resp = $client->ltr->create_featureset(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.create_featureset
ltr->create_model
Create or update a model in the default feature store.
Paths served by this method:
$resp = $client->ltr->create_model(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.create_model
ltr->create_model_from_set
Create a model from an existing feature set in the default feature store.
Paths served by this method:
$resp = $client->ltr->create_model_from_set(
'body' => $body, # optional
# path parameters
'name' => $name, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.create_model_from_set
ltr->create_store
Creates a new feature store with the specified name.
Paths served by this method:
$resp = $client->ltr->create_store(
# path parameters
'store' => $store, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.create_store
ltr->delete_default_store
Deletes the default feature store.
Paths served by this method:
$resp = $client->ltr->delete_default_store(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.delete_default_store
ltr->delete_feature
Delete a feature from the default feature store.
Paths served by this method:
$resp = $client->ltr->delete_feature(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.delete_feature
ltr->delete_featureset
Delete a feature set from the default feature store.
Paths served by this method:
$resp = $client->ltr->delete_featureset(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.delete_featureset
ltr->delete_model
Delete a model from the default feature store.
Paths served by this method:
$resp = $client->ltr->delete_model(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.delete_model
ltr->delete_store
Deletes a feature store with the specified name.
Paths served by this method:
$resp = $client->ltr->delete_store(
# path parameters
'store' => $store, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.delete_store
ltr->get_feature
Get a feature from the default feature store.
Paths served by this method:
$resp = $client->ltr->get_feature(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.get_feature
ltr->get_featureset
Get a feature set from the default feature store.
Paths served by this method:
$resp = $client->ltr->get_featureset(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.get_featureset
ltr->get_model
Get a model from the default feature store.
Paths served by this method:
$resp = $client->ltr->get_model(
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.get_model
ltr->get_store
Checks if a store exists.
Paths served by this method:
$resp = $client->ltr->get_store(
# path parameters
'store' => $store, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.get_store
ltr->list_stores
Lists all available feature stores.
Paths served by this method:
$resp = $client->ltr->list_stores(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for ltr.list_stores
ltr->search_features
Search for features in a feature store.
Paths served by this method:
$resp = $client->ltr->search_features(
# path parameters
'store' => $store, # optional
# Endpoint specific query string parameters
'from' => $qval1, # number
'prefix' => $qval2, # string
'size' => $qval3, # number
# Common API query string parameters
'error_trace' => $qval4, # boolean
'filter_path' => $qval5, # list
'human' => $qval6, # boolean
'pretty' => $qval7, # boolean
'source' => $qval8, # string
);OpenSearch documentation for ltr.search_features
ltr->search_featuresets
Search for feature sets in a feature store.
Paths served by this method:
$resp = $client->ltr->search_featuresets(
# path parameters
'store' => $store, # optional
# Endpoint specific query string parameters
'from' => $qval1, # number
'prefix' => $qval2, # string
'size' => $qval3, # number
# Common API query string parameters
'error_trace' => $qval4, # boolean
'filter_path' => $qval5, # list
'human' => $qval6, # boolean
'pretty' => $qval7, # boolean
'source' => $qval8, # string
);OpenSearch documentation for ltr.search_featuresets
ltr->search_models
Search for models in a feature store.
Paths served by this method:
$resp = $client->ltr->search_models(
# path parameters
'store' => $store, # optional
# Endpoint specific query string parameters
'from' => $qval1, # number
'prefix' => $qval2, # string
'size' => $qval3, # number
# Common API query string parameters
'error_trace' => $qval4, # boolean
'filter_path' => $qval5, # list
'human' => $qval6, # boolean
'pretty' => $qval7, # boolean
'source' => $qval8, # string
);OpenSearch documentation for ltr.search_models
ltr->stats
Provides information about the current status of the LTR plugin.
Paths served by this method:
GET /_plugins/_ltr/statsGET /_plugins/_ltr/stats/{stat}GET /_plugins/_ltr/{node_id}/statsGET /_plugins/_ltr/{node_id}/stats/{stat}
$resp = $client->ltr->stats(
# path parameters
'node_id' => $node_id, # optional
'stat' => $stat, # optional
# Endpoint specific query string parameters
'timeout' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.stats
ltr->update_feature
Update a feature in the default feature store.
Paths served by this method:
$resp = $client->ltr->update_feature(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.update_feature
ltr->update_featureset
Update a feature set in the default feature store.
Paths served by this method:
$resp = $client->ltr->update_featureset(
'body' => $body, # optional
# path parameters
'id' => $id, # required
'store' => $store, # optional
# Endpoint specific query string parameters
'routing' => $qval1, # string
# Common API query string parameters
'error_trace' => $qval2, # boolean
'filter_path' => $qval3, # list
'human' => $qval4, # boolean
'pretty' => $qval5, # boolean
'source' => $qval6, # string
);OpenSearch documentation for ltr.update_featureset
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004