Package org.opensearch.index.rankeval

Class EvalQueryQuality

java.lang.Object

org.opensearch.index.rankeval.EvalQueryQuality

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class EvalQueryQuality
extends Object
implements ToXContentFragment, Writeable

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EvalQueryQuality(String id, double metricScore)
EvalQueryQuality(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	addHitsAndRatings(List<RatedSearchHit> hits)
final boolean	equals(Object obj)
static EvalQueryQuality	fromXContent(XContentParser parser, String queryId)
List<RatedSearchHit>	getHitsAndRatings()
String	getId()
MetricDetail	getMetricDetails()
final int	hashCode()
double	metricScore()
void	setMetricDetails(MetricDetail breakdown)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

EvalQueryQuality

public EvalQueryQuality(String id,
 double metricScore)

EvalQueryQuality

public EvalQueryQuality(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getId

public String getId()

metricScore

public double metricScore()

setMetricDetails

public void setMetricDetails(MetricDetail breakdown)

getMetricDetails

public MetricDetail getMetricDetails()

addHitsAndRatings

public void addHitsAndRatings(List<RatedSearchHit> hits)

getHitsAndRatings

public List<RatedSearchHit> getHitsAndRatings()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static EvalQueryQuality fromXContent(XContentParser parser,
 String queryId)
                                     throws IOException

Throws:

IOException

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object