Package org.opensearch.index.rankeval

Class RankEvalResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

org.opensearch.index.rankeval.RankEvalResponse

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class RankEvalResponse
extends ActionResponse
implements ToXContentObject

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

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportResponse

TransportResponse.Empty

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
RankEvalResponse(double metricScore, Map<String,EvalQueryQuality> partialResults, Map<String,Exception> failures)

Method Summary

Modifier and Type	Method	Description
static RankEvalResponse	fromXContent(XContentParser parser)
Map<String,Exception>	getFailures()
double	getMetricScore()
Map<String,EvalQueryQuality>	getPartialResults()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isFragment

Constructor Details

RankEvalResponse

public RankEvalResponse(double metricScore,
 Map<String,EvalQueryQuality> partialResults,
 Map<String,Exception> failures)

Method Details

getMetricScore

public double getMetricScore()

getPartialResults

public Map<String,EvalQueryQuality> getPartialResults()

getFailures

public Map<String,Exception> getFailures()

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static RankEvalResponse fromXContent(XContentParser parser)
                                     throws IOException

Throws:

IOException