org.elasticsearch.script

Interface ExplainableSearchScript

All Superinterfaces:

ExecutableScript, LeafSearchScript, ScorerAware

public interface ExplainableSearchScript
extends LeafSearchScript

To be implemented by SearchScript which can provided an Explanation of the score This is currently not used inside elasticsearch but it is used, see for example here: https://github.com/elasticsearch/elasticsearch/issues/8561

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	explain(org.apache.lucene.search.Explanation subQueryScore) Build the explanation of the current document being scored The script score needs the Explanation of the sub query score because it might use _score and want to explain how that was computed.

Methods inherited from interface org.elasticsearch.script.LeafSearchScript

runAsDouble, runAsFloat, runAsLong, setDocument, setSource

Methods inherited from interface org.elasticsearch.common.lucene.ScorerAware

setScorer

Methods inherited from interface org.elasticsearch.script.ExecutableScript

run, setNextVar, unwrap

Method Detail

explain

org.apache.lucene.search.Explanation explain(org.apache.lucene.search.Explanation subQueryScore)
                                             throws IOException

Build the explanation of the current document being scored The script score needs the Explanation of the sub query score because it might use _score and want to explain how that was computed.

Parameters:

subQueryScore - the Explanation for _score

Throws:

IOException