Package org.opensearch.index.rankeval

Interface MetricDetail

All Superinterfaces:

NamedWriteable, ToXContent, ToXContentObject, Writeable

All Known Implementing Classes:

DiscountedCumulativeGain.Detail, ExpectedReciprocalRank.Detail, MeanReciprocalRank.Detail, PrecisionAtK.Detail, RecallAtK.Detail

public interface MetricDetail
extends ToXContentObject, NamedWriteable

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

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 java.lang.Object>, Writeable.Writer<V extends java.lang.Object>

Field Summary

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getMetricName()
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)	Implementations should write their own fields to the XContentBuilder passed in.
default XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from interface org.opensearch.common.io.stream.NamedWriteable

getWriteableName

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

isFragment

Methods inherited from interface org.opensearch.common.io.stream.Writeable

writeTo

Method Detail

toXContent

default XContentBuilder toXContent(XContentBuilder builder,
                                   ToXContent.Params params)
                            throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

getMetricName

default java.lang.String getMetricName()

innerToXContent

XContentBuilder innerToXContent(XContentBuilder builder,
                                ToXContent.Params params)
                         throws java.io.IOException

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

Throws:

java.io.IOException