honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reformats ranking evaluation API (#46974) 

* [DOCS] Reformats ranking evaluation API.
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
This commit is contained in:
István Zoltán Szabó 2019-09-25 14:55:09 +02:00
parent 22575bd7e6
commit 74fd21f0b0
1 changed files with 147 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
docs/reference/search/rank-eval.asciidoc
View File

@ -3,35 +3,87 @@
experimental["The ranking evaluation API is experimental and may be changed or removed completely in a future release, as well as change in non-backwards compatible ways on minor versions updates. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features."] experimental["The ranking evaluation API is experimental and may be changed or removed completely in a future release, as well as change in non-backwards compatible ways on minor versions updates. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features."]
The ranking evaluation API allows to evaluate the quality of ranked search Allows you to evaluate the quality of ranked search results over a set of
typical search queries.
[[search-rank-eval-api-request]]
==== {api-request-title}
`GET /<index>/_rank_eval`
`POST /<index>/_rank_eval`
[[search-rank-eval-api-desc]]
==== {api-description-title}
The ranking evaluation API allows you to evaluate the quality of ranked search
results over a set of typical search queries. Given this set of queries and a results over a set of typical search queries. Given this set of queries and a
list of manually rated documents, the `_rank_eval` endpoint calculates and list of manually rated documents, the `_rank_eval` endpoint calculates and
returns typical information retrieval metrics like _mean reciprocal rank_, returns typical information retrieval metrics like _mean reciprocal rank_,
_precision_ or _discounted cumulative gain_. _precision_ or _discounted cumulative gain_.
[float] Search quality evaluation starts with looking at the users of your search
==== Overview application, and the things that they are searching for. Users have a specific
_information need_, for example they are looking for gift in a web shop or want
to book a flight for their next holiday. They usually enter some search terms
into a search box or some other web form. All of this information, together with
meta information about the user (for example the browser, location, earlier
preferences and so on) then gets translated into a query to the underlying
search system.
Search quality evaluation starts with looking at the users of your search application, and the things that they are searching for. The challenge for search engineers is to tweak this translation process from
Users have a specific _information need_, e.g. they are looking for gift in a web shop or want to book a flight for their next holiday. user entries to a concrete query in such a way, that the search results contain
They usually enter some search terms into a search box or some other web form. the most relevant information with respect to the users information need. This
All of this information, together with meta information about the user (e.g. the browser, location, earlier preferences etc...) then gets translated into a query to the underlying search system. can only be done if the search result quality is evaluated constantly across a
representative test suite of typical user queries, so that improvements in the
rankings for one particular query doesn't negatively effect the ranking for
other types of queries.
The challenge for search engineers is to tweak this translation process from user entries to a concrete query in such a way, that the search results contain the most relevant information with respect to the users information need. In order to get started with search quality evaluation, three basic things are
This can only be done if the search result quality is evaluated constantly across a representative test suite of typical user queries, so that improvements in the rankings for one particular query doesn't negatively effect the ranking for other types of queries. needed:
In order to get started with search quality evaluation, three basic things are needed: . A collection of documents you want to evaluate your query performance against,
usually one or more indices.
. A collection of typical search requests that users enter into your system.
. A set of document ratings that judge the documents relevance with respect to a
search request.
It is important to note that one set of document ratings is needed per test
query, and that the relevance judgements are based on the information need of
the user that entered the query.
. a collection of documents you want to evaluate your query performance against, usually one or more indices The ranking evaluation API provides a convenient way to use this information in
. a collection of typical search requests that users enter into your system a ranking evaluation request to calculate different search evaluation metrics.
. a set of document ratings that judge the documents relevance with respect to a search request+ This gives a first estimation of your overall search quality and give you a
It is important to note that one set of document ratings is needed per test query, and that measurement to optimize against when fine-tuning various aspect of the query
the relevance judgements are based on the information need of the user that entered the query. generation in your application.
The ranking evaluation API provides a convenient way to use this information in a ranking evaluation request to calculate different search evaluation metrics. This gives a first estimation of your overall search quality and give you a measurement to optimize against when fine-tuning various aspect of the query generation in your application.
[float] [[search-rank-eval-api-path-params]]
==== Ranking evaluation request structure ==== {api-path-parms-title}
`<index>`::
(Required, string) Comma-separated list or wildcard expression of index names
used to limit the request.
[[search-rank-eval-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
--
Defaults to `open`.
--
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
[[search-rank-eval-api-example]]
==== {api-examples-title}
In its most basic form, a request to the `_rank_eval` endpoint has two sections: In its most basic form, a request to the `_rank_eval` endpoint has two sections:
@ -51,10 +103,13 @@ GET /my_index/_rank_eval
<2> definition of the evaluation metric to calculate <2> definition of the evaluation metric to calculate
<3> a specific metric and its parameters <3> a specific metric and its parameters
The request section contains several search requests typical to your application, along with the document ratings for each particular search request, e.g. The request section contains several search requests typical to your
application, along with the document ratings for each particular search request.
[source,js] [source,js]
----------------------------- -----------------------------
GET /my_index/_rank_eval
{
"requests": [ "requests": [
{ {
"id": "amsterdam_query", <1> "id": "amsterdam_query", <1>
@ -77,20 +132,30 @@ The request section contains several search requests typical to your application
] ]
} }
] ]
}
----------------------------- -----------------------------
// NOTCONSOLE // NOTCONSOLE
<1> the search requests id, used to group result details later <1> the search requests id, used to group result details later
<2> the query that is being evaluated <2> the query that is being evaluated
<3> a list of document ratings, each entry containing the documents `_index` and `_id` together with <3> a list of document ratings, each entry containing the documents `_index` and
the rating of the documents relevance with regards to this search request `_id` together with the rating of the documents relevance with regards to this
search request
A document `rating` can be any integer value that expresses the relevance of the document on a user defined scale. For some of the metrics, just giving a binary rating (e.g. `0` for irrelevant and `1` for relevant) will be sufficient, other metrics can use a more fine grained scale. A document `rating` can be any integer value that expresses the relevance of the
document on a user defined scale. For some of the metrics, just giving a binary
rating (for example `0` for irrelevant and `1` for relevant) will be sufficient,
other metrics can use a more fine grained scale.
[float]
==== Template based ranking evaluation
As an alternative to having to provide a single query per test request, it is possible to specify query templates in the evaluation request and later refer to them. Queries with similar structure that only differ in their parameters don't have to be repeated all the time in the `requests` section this way. In typical search systems where user inputs usually get filled into a small set of query templates, this helps making the evaluation request more succinct. ===== Template based ranking evaluation
As an alternative to having to provide a single query per test request, it is
possible to specify query templates in the evaluation request and later refer to
them. Queries with similar structure that only differ in their parameters don't
have to be repeated all the time in the `requests` section this way. In typical
search systems where user inputs usually get filled into a small set of query
templates, this helps making the evaluation request more succinct.
[source,js] [source,js]
-------------------------------- --------------------------------
@ -129,23 +194,30 @@ GET /my_index/_rank_eval
<3> a reference to a previously defined template <3> a reference to a previously defined template
<4> the parameters to use to fill the template <4> the parameters to use to fill the template
[float]
==== Available evaluation metrics
The `metric` section determines which of the available evaluation metrics is going to be used. ===== Available evaluation metrics
Currently, the following metrics are supported:
The `metric` section determines which of the available evaluation metrics is
going to be used. The following metrics are supported:
[float] [float]
[[k-precision]] [[k-precision]]
===== Precision at K (P@k) ===== Precision at K (P@k)
This metric measures the number of relevant results in the top k search results. Its a form of the well known https://en.wikipedia.org/wiki/Information_retrieval#Precision[Precision] metric that only looks at the top k documents. It is the fraction of relevant documents in those first k This metric measures the number of relevant results in the top k search results.
search. A precision at 10 (P@10) value of 0.6 then means six out of the 10 top hits are relevant with respect to the users information need. Its a form of the well known
https://en.wikipedia.org/wiki/Information_retrieval#Precision[Precision] metric
that only looks at the top k documents. It is the fraction of relevant documents
in those first k search. A precision at 10 (P@10) value of 0.6 then means six
out of the 10 top hits are relevant with respect to the users information need.
P@k works well as a simple evaluation metric that has the benefit of being easy to understand and explain. P@k works well as a simple evaluation metric that has the benefit of being easy
Documents in the collection need to be rated either as relevant or irrelevant with respect to the current query. to understand and explain. Documents in the collection need to be rated either
P@k does not take into account where in the top k results the relevant documents occur, so a ranking of ten results that as relevant or irrelevant with respect to the current query. P@k does not take
contains one relevant result in position 10 is equally good as a ranking of ten results that contains one relevant result in position 1. into account where in the top k results the relevant documents occur, so a
ranking of ten results that contains one relevant result in position 10 is
equally good as a ranking of ten results that contains one relevant result in
position 1.
[source,console] [source,console]
-------------------------------- --------------------------------
@ -181,13 +253,15 @@ in the query. Defaults to 10.
If set to 'true', unlabeled documents are ignored and neither count as relevant or irrelevant. Set to 'false' (the default), they are treated as irrelevant. If set to 'true', unlabeled documents are ignored and neither count as relevant or irrelevant. Set to 'false' (the default), they are treated as irrelevant.
|======================================================================= |=======================================================================
[float] [float]
===== Mean reciprocal rank ===== Mean reciprocal rank
For every query in the test suite, this metric calculates the reciprocal of the rank of the For every query in the test suite, this metric calculates the reciprocal of the
first relevant document. For example finding the first relevant result rank of the first relevant document. For example finding the first relevant
in position 3 means the reciprocal rank is 1/3. The reciprocal rank for each query result in position 3 means the reciprocal rank is 1/3. The reciprocal rank for
is averaged across all queries in the test suite to give the https://en.wikipedia.org/wiki/Mean_reciprocal_rank[mean reciprocal rank]. each query is averaged across all queries in the test suite to give the
https://en.wikipedia.org/wiki/Mean_reciprocal_rank[mean reciprocal rank].
[source,console] [source,console]
-------------------------------- --------------------------------
@ -220,12 +294,18 @@ in the query. Defaults to 10.
"relevant". Defaults to `1`. "relevant". Defaults to `1`.
|======================================================================= |=======================================================================
[float] [float]
===== Discounted cumulative gain (DCG) ===== Discounted cumulative gain (DCG)
In contrast to the two metrics above, https://en.wikipedia.org/wiki/Discounted_cumulative_gain[discounted cumulative gain] takes both, the rank and the rating of the search results, into account. In contrast to the two metrics above,
https://en.wikipedia.org/wiki/Discounted_cumulative_gain[discounted cumulative gain]
takes both, the rank and the rating of the search results, into account.
The assumption is that highly relevant documents are more useful for the user when appearing at the top of the result list. Therefore, the DCG formula reduces the contribution that high ratings for documents on lower search ranks have on the overall DCG metric. The assumption is that highly relevant documents are more useful for the user
when appearing at the top of the result list. Therefore, the DCG formula reduces
the contribution that high ratings for documents on lower search ranks have on
the overall DCG metric.
[source,console] [source,console]
-------------------------------- --------------------------------
@ -257,23 +337,31 @@ in the query. Defaults to 10.
|`normalize` | If set to `true`, this metric will calculate the https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG[Normalized DCG]. |`normalize` | If set to `true`, this metric will calculate the https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG[Normalized DCG].
|======================================================================= |=======================================================================
[float] [float]
===== Expected Reciprocal Rank (ERR) ===== Expected Reciprocal Rank (ERR)
Expected Reciprocal Rank (ERR) is an extension of the classical reciprocal rank for the graded relevance case Expected Reciprocal Rank (ERR) is an extension of the classical reciprocal rank
(Olivier Chapelle, Donald Metzler, Ya Zhang, and Pierre Grinspan. 2009. http://olivier.chapelle.cc/pub/err.pdf[Expected reciprocal rank for graded relevance].) for the graded relevance case (Olivier Chapelle, Donald Metzler, Ya Zhang, and
Pierre Grinspan. 2009.
http://olivier.chapelle.cc/pub/err.pdf[Expected reciprocal rank for graded relevance].)
It is based on the assumption of a cascade model of search, in which a user scans through ranked search It is based on the assumption of a cascade model of search, in which a user
results in order and stops at the first document that satisfies the information need. For this reason, it scans through ranked search results in order and stops at the first document
is a good metric for question answering and navigation queries, but less so for survey oriented information that satisfies the information need. For this reason, it is a good metric for
needs where the user is interested in finding many relevant documents in the top k results. question answering and navigation queries, but less so for survey oriented
information needs where the user is interested in finding many relevant
documents in the top k results.
The metric models the expectation of the reciprocal of the position at which a user stops reading through The metric models the expectation of the reciprocal of the position at which a
the result list. This means that relevant document in top ranking positions will contribute much to the user stops reading through the result list. This means that relevant document in
overall score. However, the same document will contribute much less to the score if it appears in a lower rank, top ranking positions will contribute much to the overall score. However, the
even more so if there are some relevant (but maybe less relevant) documents preceding it. same document will contribute much less to the score if it appears in a lower
In this way, the ERR metric discounts documents which are shown after very relevant documents. This introduces rank, even more so if there are some relevant (but maybe less relevant)
a notion of dependency in the ordering of relevant documents that e.g. Precision or DCG don't account for. documents preceding it. In this way, the ERR metric discounts documents which
are shown after very relevant documents. This introduces a notion of dependency
in the ordering of relevant documents that e.g. Precision or DCG don't account
for.
[source,console] [source,console]
-------------------------------- --------------------------------
@ -306,12 +394,13 @@ relevance judgments.
in the query. Defaults to 10. in the query. Defaults to 10.
|======================================================================= |=======================================================================
[float]
==== Response format
The response of the `_rank_eval` endpoint contains the overall calculated result for the defined quality metric, ===== Response format
a `details` section with a breakdown of results for each query in the test suite and an optional `failures` section
that shows potential errors of individual queries. The response has the following format: The response of the `_rank_eval` endpoint contains the overall calculated result
for the defined quality metric, a `details` section with a breakdown of results
for each query in the test suite and an optional `failures` section that shows
potential errors of individual queries. The response has the following format:
[source,js] [source,js]
-------------------------------- --------------------------------