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.ParamsNested 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
-
Method Summary
Modifier and Type Method Description default java.lang.StringgetMetricName()XContentBuilderinnerToXContent(XContentBuilder builder, ToXContent.Params params)Implementations should write their own fields to theXContentBuilderpassed in.default XContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)
-
Method Details
-
toXContent
default XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContentin interfaceToXContent- Throws:
java.io.IOException
-
getMetricName
default java.lang.String getMetricName() -
innerToXContent
XContentBuilder innerToXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOExceptionImplementations should write their own fields to theXContentBuilderpassed in.- Throws:
java.io.IOException
-