NAME
OpenSearch::Client::Core::3_0::Direct::SearchRelevance
VERSION
version 3.007004
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->search_relevance-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Search Relevance Workbench
In search applications, tuning relevance is a constant, iterative exercise intended to provide the right search results to your end users. The tooling in Search Relevance Workbench helps search relevance engineers and business users create the best search experience possible for application users. It does this without hiding internal information, enabling engineers to experiment and investigate details as necessary.
See OpenSearch documentation for search_relevance.
METHODS
search_relevance->delete_experiments
Deletes a specified experiment.
Paths served by this method:
$resp = $client->search_relevance->delete_experiments(
# path parameters
'experiment_id' => $experiment_id, # 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 search_relevance.delete_experiments
search_relevance->delete_judgments
Deletes a specified judgment.
Paths served by this method:
$resp = $client->search_relevance->delete_judgments(
# path parameters
'judgment_id' => $judgment_id, # 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 search_relevance.delete_judgments
search_relevance->delete_query_sets
Deletes a query set.
Paths served by this method:
$resp = $client->search_relevance->delete_query_sets(
# path parameters
'query_set_id' => $query_set_id, # 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 search_relevance.delete_query_sets
search_relevance->delete_scheduled_experiments
Deletes a specified scheduled experiment.
Paths served by this method:
$resp = $client->search_relevance->delete_scheduled_experiments(
# path parameters
'experiment_id' => $experiment_id, # 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 search_relevance.delete_scheduled_experiments
search_relevance->delete_search_configurations
Deletes a specified search configuration.
Paths served by this method:
$resp = $client->search_relevance->delete_search_configurations(
# path parameters
'search_configuration_id' => $search_configuration_id, # 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 search_relevance.delete_search_configurations
search_relevance->get_experiments
Gets experiments.
Paths served by this method:
GET /_plugins/_search_relevance/experimentsGET /_plugins/_search_relevance/experiments/{experiment_id}
$resp = $client->search_relevance->get_experiments(
# path parameters
'experiment_id' => $experiment_id, # 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 search_relevance.get_experiments
search_relevance->get_judgments
Gets judgments.
Paths served by this method:
$resp = $client->search_relevance->get_judgments(
# path parameters
'judgment_id' => $judgment_id, # 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 search_relevance.get_judgments
search_relevance->get_node_stats
Gets stats by node.
Paths served by this method:
GET /_plugins/_search_relevance/{node_id}/statsGET /_plugins/_search_relevance/{node_id}/stats/{stat}
$resp = $client->search_relevance->get_node_stats(
# path parameters
'node_id' => $node_id, # required
'stat' => $stat, # optional
# Endpoint specific query string parameters
'flat_stat_paths' => $qval1, # string
'include_all_nodes' => $qval2, # string
'include_individual_nodes' => $qval3, # string
'include_info' => $qval4, # string
'include_metadata' => $qval5, # string
# Common API query string parameters
'error_trace' => $qval6, # boolean
'filter_path' => $qval7, # list
'human' => $qval8, # boolean
'pretty' => $qval9, # boolean
'source' => $qval10, # string
);OpenSearch documentation for search_relevance.get_node_stats
search_relevance->get_query_sets
Lists the current query sets available.
Paths served by this method:
GET /_plugins/_search_relevance/query_setsGET /_plugins/_search_relevance/query_sets/{query_set_id}
$resp = $client->search_relevance->get_query_sets(
# path parameters
'query_set_id' => $query_set_id, # 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 search_relevance.get_query_sets
search_relevance->get_scheduled_experiments
Gets the scheduled experiments.
Paths served by this method:
GET /_plugins/_search_relevance/experiments/scheduleGET /_plugins/_search_relevance/experiments/schedule/{experiment_id}
$resp = $client->search_relevance->get_scheduled_experiments(
# path parameters
'experiment_id' => $experiment_id, # 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 search_relevance.get_scheduled_experiments
search_relevance->get_search_configurations
Gets the search configurations.
Paths served by this method:
GET /_plugins/_search_relevance/search_configurationsGET /_plugins/_search_relevance/search_configurations/{search_configuration_id}
$resp = $client->search_relevance->get_search_configurations(
# path parameters
'search_configuration_id' => $search_configuration_id, # 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 search_relevance.get_search_configurations
search_relevance->get_stats
Gets stats.
Paths served by this method:
$resp = $client->search_relevance->get_stats(
# path parameters
'stat' => $stat, # optional
# Endpoint specific query string parameters
'flat_stat_paths' => $qval1, # string
'include_all_nodes' => $qval2, # string
'include_individual_nodes' => $qval3, # string
'include_info' => $qval4, # string
'include_metadata' => $qval5, # string
# Common API query string parameters
'error_trace' => $qval6, # boolean
'filter_path' => $qval7, # list
'human' => $qval8, # boolean
'pretty' => $qval9, # boolean
'source' => $qval10, # string
);OpenSearch documentation for search_relevance.get_stats
search_relevance->post_query_sets
Creates a new query set by sampling queries from the user behavior data.
Paths served by this method:
$resp = $client->search_relevance->post_query_sets(
'body' => $body, # 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 search_relevance.post_query_sets
search_relevance->post_scheduled_experiments
Creates a scheduled experiment.
Paths served by this method:
$resp = $client->search_relevance->post_scheduled_experiments(
'body' => $body, # 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 search_relevance.post_scheduled_experiments
search_relevance->put_experiments
Creates an experiment.
Paths served by this method:
$resp = $client->search_relevance->put_experiments(
'body' => $body, # 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 search_relevance.put_experiments
search_relevance->put_judgments
Creates a judgment.
Paths served by this method:
$resp = $client->search_relevance->put_judgments(
'body' => $body, # 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 search_relevance.put_judgments
search_relevance->put_query_sets
Creates a new query set by uploading manually.
Paths served by this method:
$resp = $client->search_relevance->put_query_sets(
'body' => $body, # 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 search_relevance.put_query_sets
search_relevance->put_search_configurations
Creates a search configuration.
Paths served by this method:
$resp = $client->search_relevance->put_search_configurations(
'body' => $body, # 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 search_relevance.put_search_configurations
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