A C D E F G H I J M N O P R S T V W

A

addHitsAndRatings(List<RatedSearchHit>) - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

addSummaryFields(List<String>) - Method in class org.elasticsearch.index.rankeval.RatedRequest

C

combine(Collection<EvalQueryQuality>) - Method in interface org.elasticsearch.index.rankeval.EvaluationMetric

how evaluation metrics for particular search queries get combined for the overall evaluation score.

D

DiscountedCumulativeGain - Class in org.elasticsearch.index.rankeval

Metric implementing Discounted Cumulative Gain.

DiscountedCumulativeGain() - Constructor for class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

DiscountedCumulativeGain(boolean, Integer, int) - Constructor for class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

doExecute(RankEvalRequest, ActionListener<RankEvalResponse>) - Method in class org.elasticsearch.index.rankeval.TransportRankEvalAction

E

ENDPOINT - Static variable in class org.elasticsearch.index.rankeval.RestRankEvalAction

equals(Object) - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

equals(Object) - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

equals(Object) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

equals(Object) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

equals(Object) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

equals(Object) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

equals(Object) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

equals(Object) - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

equals(Object) - Method in class org.elasticsearch.index.rankeval.RatedDocument

equals(Object) - Method in class org.elasticsearch.index.rankeval.RatedRequest

equals(Object) - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

EvalQueryQuality - Class in org.elasticsearch.index.rankeval

Result of the evaluation metric calculation on one particular query alone.

EvalQueryQuality(String, double) - Constructor for class org.elasticsearch.index.rankeval.EvalQueryQuality

EvalQueryQuality(StreamInput) - Constructor for class org.elasticsearch.index.rankeval.EvalQueryQuality

evaluate(String, SearchHit[], List<RatedDocument>) - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

evaluate(String, SearchHit[], List<RatedDocument>) - Method in interface org.elasticsearch.index.rankeval.EvaluationMetric

Returns a single metric representing the ranking quality of a set of returned documents wrt.

evaluate(String, SearchHit[], List<RatedDocument>) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

Compute ReciprocalRank based on provided relevant document IDs.

evaluate(String, SearchHit[], List<RatedDocument>) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

Compute precisionAtN based on provided relevant document IDs.

EvaluationMetric - Interface in org.elasticsearch.index.rankeval

Implementations of EvaluationMetric need to provide a way to compute the quality metric for a result list returned by some search (@link SearchHits) and a list of rated documents.

F

filterUnknownDocuments(List<RatedSearchHit>) - Static method in interface org.elasticsearch.index.rankeval.EvaluationMetric

filter @link RatedSearchHit that don't have a rating

forcedSearchSize() - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

forcedSearchSize() - Method in interface org.elasticsearch.index.rankeval.EvaluationMetric

Metrics can define a size of the search hits windows they want to retrieve by overwriting this method.

forcedSearchSize() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

forcedSearchSize() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.PrecisionAtK

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.RankEvalResponse

fromXContent(XContentParser) - Static method in class org.elasticsearch.index.rankeval.RatedRequest

parse from rest representation

fromXContent(XContentParser, String) - Static method in class org.elasticsearch.index.rankeval.EvalQueryQuality

G

getActions() - Method in class org.elasticsearch.index.rankeval.RankEvalPlugin

getDocID() - Method in class org.elasticsearch.index.rankeval.RatedDocument

getEvaluationResult() - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

getFailures() - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

getFirstRelevantRank() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

the ranking of the first relevant document, or -1 if no relevant document was found

getHitsAndRatings() - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

getId() - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

getId() - Method in class org.elasticsearch.index.rankeval.RatedRequest

return the user supplied request id

getIgnoreUnlabeled() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

Gets the 'ignore_unlabeled' parameter.

getIndex() - Method in class org.elasticsearch.index.rankeval.RatedDocument

getKey() - Method in class org.elasticsearch.index.rankeval.RatedDocument

getMaxConcurrentSearches() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

Returns the max concurrent searches allowed.

getMetric() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

Returns the metric to use for quality evaluation.

getMetricDetails() - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

getMetricName() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

getMetricName() - Method in interface org.elasticsearch.index.rankeval.MetricDetail

getName() - Method in class org.elasticsearch.index.rankeval.RestRankEvalAction

getNamedWriteables() - Method in class org.elasticsearch.index.rankeval.RankEvalPlugin

getNamedXContent() - Method in class org.elasticsearch.index.rankeval.RankEvalPlugin

getNamedXContentParsers() - Method in class org.elasticsearch.index.rankeval.RankEvalNamedXContentProvider

getParams() - Method in class org.elasticsearch.index.rankeval.RatedRequest

return the parameters if this request uses a template, otherwise this will be empty.

getPartialResults() - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

getQualityLevel() - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

getRankEvalSpec() - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

Returns the specification of the ranking evaluation.

getRankEvalSpec() - Method in class org.elasticsearch.index.rankeval.RankEvalRequestBuilder

getRatedDocs() - Method in class org.elasticsearch.index.rankeval.RatedRequest

return the list of rated documents to evaluate.

getRatedRequests() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

Returns a list of intent to query translation specifications to evaluate.

getRating() - Method in class org.elasticsearch.index.rankeval.RatedDocument

getRating() - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

getRelevantRatingThreshold() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

Return the rating threshold above which ratings are considered to be "relevant".

getRelevantRatingThreshold() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

Return the rating threshold above which ratings are considered to be "relevant" for this metric.

getRelevantRetrieved() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

getRestHandlers(Settings, RestController, ClusterSettings, IndexScopedSettings, SettingsFilter, IndexNameExpressionResolver, Supplier<DiscoveryNodes>) - Method in class org.elasticsearch.index.rankeval.RankEvalPlugin

getRetrieved() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

getSearchHit() - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

getSummaryFields() - Method in class org.elasticsearch.index.rankeval.RatedRequest

returns a list of fields that should be included in the document summary for matched documents

getTemplateId() - Method in class org.elasticsearch.index.rankeval.RatedRequest

return the parameters if this request uses a template, otherwise this will be null.

getTemplates() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

Returns the template to base test requests on.

getTestRequest() - Method in class org.elasticsearch.index.rankeval.RatedRequest

getUnknownDocRating() - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

get the rating used for unrated documents

getWriteableName() - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

getWriteableName() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

getWriteableName() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

getWriteableName() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

getWriteableName() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

H

hashCode() - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

hashCode() - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

hashCode() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

hashCode() - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

hashCode() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

hashCode() - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

hashCode() - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

hashCode() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

hashCode() - Method in class org.elasticsearch.index.rankeval.RatedDocument

hashCode() - Method in class org.elasticsearch.index.rankeval.RatedRequest

hashCode() - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

I

indices() - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

indices(String...) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

Sets the indices the search will be executed on.

indicesOptions() - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

indicesOptions(IndicesOptions) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

innerToXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

innerToXContent(XContentBuilder, ToXContent.Params) - Method in interface org.elasticsearch.index.rankeval.MetricDetail

Implementations should write their own fields to the XContentBuilder passed in.

innerToXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

INSTANCE - Static variable in class org.elasticsearch.index.rankeval.RankEvalAction

J

joinHitsWithRatings(SearchHit[], List<RatedDocument>) - Static method in interface org.elasticsearch.index.rankeval.EvaluationMetric

join hits with rated documents using the joint _index/_id document key

M

MeanReciprocalRank - Class in org.elasticsearch.index.rankeval

Metric implementing Mean Reciprocal Rank (https://en.wikipedia.org/wiki/Mean_reciprocal_rank).
By default documents with a rating equal or bigger than 1 are considered to be "relevant" for the reciprocal rank calculation.

MeanReciprocalRank() - Constructor for class org.elasticsearch.index.rankeval.MeanReciprocalRank

MeanReciprocalRank(int, int) - Constructor for class org.elasticsearch.index.rankeval.MeanReciprocalRank

Metric implementing Mean Reciprocal Rank (https://en.wikipedia.org/wiki/Mean_reciprocal_rank).

MeanReciprocalRank.Detail - Class in org.elasticsearch.index.rankeval

MetricDetail - Interface in org.elasticsearch.index.rankeval

Details about a specific EvaluationMetric that should be included in the resonse.

N

NAME - Static variable in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

NAME - Static variable in class org.elasticsearch.index.rankeval.MeanReciprocalRank

NAME - Static variable in class org.elasticsearch.index.rankeval.PrecisionAtK

NAME - Static variable in class org.elasticsearch.index.rankeval.RankEvalAction

newRequestBuilder(ElasticsearchClient) - Method in class org.elasticsearch.index.rankeval.RankEvalAction

newResponse() - Method in class org.elasticsearch.index.rankeval.RankEvalAction

O

org.elasticsearch.index.rankeval - package org.elasticsearch.index.rankeval

P

parse(XContentParser) - Static method in class org.elasticsearch.index.rankeval.RankEvalSpec

parse(XContentParser) - Static method in class org.elasticsearch.index.rankeval.RatedSearchHit

PrecisionAtK - Class in org.elasticsearch.index.rankeval

Metric implementing Precision@K (https://en.wikipedia.org/wiki/Information_retrieval#Precision_at_K).
By default documents with a rating equal or bigger than 1 are considered to be "relevant" for this calculation.

PrecisionAtK() - Constructor for class org.elasticsearch.index.rankeval.PrecisionAtK

PrecisionAtK(int, boolean, int) - Constructor for class org.elasticsearch.index.rankeval.PrecisionAtK

Metric implementing Precision@K.

PrecisionAtK.Detail - Class in org.elasticsearch.index.rankeval

prepareRequest(RestRequest, NodeClient) - Method in class org.elasticsearch.index.rankeval.RestRankEvalAction

R

RankEvalAction - Class in org.elasticsearch.index.rankeval

Action for explaining evaluating search ranking results.

RankEvalNamedXContentProvider - Class in org.elasticsearch.index.rankeval

RankEvalNamedXContentProvider() - Constructor for class org.elasticsearch.index.rankeval.RankEvalNamedXContentProvider

RankEvalPlugin - Class in org.elasticsearch.index.rankeval

RankEvalPlugin() - Constructor for class org.elasticsearch.index.rankeval.RankEvalPlugin

RankEvalRequest - Class in org.elasticsearch.index.rankeval

Request to perform a search ranking evaluation.

RankEvalRequest(RankEvalSpec, String[]) - Constructor for class org.elasticsearch.index.rankeval.RankEvalRequest

RankEvalRequestBuilder - Class in org.elasticsearch.index.rankeval

RankEvalRequestBuilder(ElasticsearchClient, Action<RankEvalRequest, RankEvalResponse, RankEvalRequestBuilder>, RankEvalRequest) - Constructor for class org.elasticsearch.index.rankeval.RankEvalRequestBuilder

RankEvalResponse - Class in org.elasticsearch.index.rankeval

Returns the results for a RankEvalRequest.
The repsonse contains a detailed section for each evaluation query in the request and possible failures that happened when executin individual queries.

RankEvalResponse(double, Map<String, EvalQueryQuality>, Map<String, Exception>) - Constructor for class org.elasticsearch.index.rankeval.RankEvalResponse

RankEvalSpec - Class in org.elasticsearch.index.rankeval

Specification of the ranking evaluation request.
This class groups the queries to evaluate, including their document ratings, and the evaluation metric including its parameters.

RankEvalSpec(List<RatedRequest>, EvaluationMetric) - Constructor for class org.elasticsearch.index.rankeval.RankEvalSpec

RankEvalSpec(List<RatedRequest>, EvaluationMetric, Collection<RankEvalSpec.ScriptWithId>) - Constructor for class org.elasticsearch.index.rankeval.RankEvalSpec

RankEvalSpec(StreamInput) - Constructor for class org.elasticsearch.index.rankeval.RankEvalSpec

RatedDocument - Class in org.elasticsearch.index.rankeval

Represents a document (specified by its _index/_id) and its corresponding rating with respect to a specific search query.

RatedDocument(String, String, int) - Constructor for class org.elasticsearch.index.rankeval.RatedDocument

RatedRequest - Class in org.elasticsearch.index.rankeval

Definition of a particular query in the ranking evaluation request.
This usually represents a single user search intent and consists of an id (ideally human readable and referencing the search intent), the list of indices to be queries and the SearchSourceBuilder that will be used to create the search request for this search intent.
Alternatively, a template id and template parameters can be provided instead.
Finally, a list of rated documents for this query also needs to be provided.

RatedRequest(String, List<RatedDocument>, Map<String, Object>, String) - Constructor for class org.elasticsearch.index.rankeval.RatedRequest

RatedRequest(String, List<RatedDocument>, SearchSourceBuilder) - Constructor for class org.elasticsearch.index.rankeval.RatedRequest

RatedRequest(StreamInput) - Constructor for class org.elasticsearch.index.rankeval.RatedRequest

RatedSearchHit - Class in org.elasticsearch.index.rankeval

Combines a SearchHit with a document rating.

RatedSearchHit(SearchHit, Optional<Integer>) - Constructor for class org.elasticsearch.index.rankeval.RatedSearchHit

readFrom(StreamInput) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

readFrom(StreamInput) - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

request() - Method in class org.elasticsearch.index.rankeval.RankEvalRequestBuilder

RestRankEvalAction - Class in org.elasticsearch.index.rankeval

{ "requests": [{ "id": "amsterdam_query", "request": { "query": { "match": { "text": "amsterdam" } } }, "ratings": [{ "_index": "foo", "_id": "doc1", "rating": 0 }, { "_index": "foo", "_id": "doc2", "rating": 1 }, { "_index": "foo", "_id": "doc3", "rating": 1 } ] }, { "id": "berlin_query", "request": { "query": { "match": { "text": "berlin" } }, "size": 10 }, "ratings": [{ "_index": "foo", "_id": "doc1", "rating": 1 }] } ], "metric": { "precision": { "ignore_unlabeled": true } } }

RestRankEvalAction(Settings, RestController) - Constructor for class org.elasticsearch.index.rankeval.RestRankEvalAction

S

setMaxConcurrentSearches(int) - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

Set the max concurrent searches allowed.

setMetricDetails(MetricDetail) - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

setRankEvalSpec(RankEvalSpec) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

Set the the specification of the ranking evaluation.

setRankEvalSpec(RankEvalSpec) - Method in class org.elasticsearch.index.rankeval.RankEvalRequestBuilder

T

toString() - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

toString() - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

toString() - Method in class org.elasticsearch.index.rankeval.RatedDocument

toString() - Method in class org.elasticsearch.index.rankeval.RatedRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

toXContent(XContentBuilder, ToXContent.Params) - Method in interface org.elasticsearch.index.rankeval.MetricDetail

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.RatedDocument

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.RatedRequest

toXContent(XContentBuilder, ToXContent.Params) - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

TransportRankEvalAction - Class in org.elasticsearch.index.rankeval

Instances of this class execute a collection of search intents (read: user supplied query parameters) against a set of possible search requests (read: search specifications, expressed as query/search request templates) and compares the result against a set of annotated documents per search intent.

TransportRankEvalAction(Settings, ThreadPool, ActionFilters, IndexNameExpressionResolver, Client, TransportService, ScriptService, NamedXContentRegistry) - Constructor for class org.elasticsearch.index.rankeval.TransportRankEvalAction

V

validate() - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

W

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.DiscountedCumulativeGain

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.EvalQueryQuality

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank.Detail

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.MeanReciprocalRank

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK.Detail

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.PrecisionAtK

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RankEvalRequest

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RankEvalResponse

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RankEvalSpec

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RatedDocument

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RatedRequest

writeTo(StreamOutput) - Method in class org.elasticsearch.index.rankeval.RatedSearchHit

A C D E F G H I J M N O P R S T V W