Package org.elasticsearch.index.rankeval

Interface MetricDetail

All Superinterfaces:

org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.common.io.stream.Writeable

All Known Implementing Classes:

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

public interface MetricDetail
extends org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.common.io.stream.NamedWriteable

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

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

Field Summary

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

EMPTY_PARAMS

Method Summary

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

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

getWriteableName

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

isFragment

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

writeTo

Method Detail

toXContent

default org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                     org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                              throws java.io.IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

java.io.IOException

getMetricName

default java.lang.String getMetricName()

innerToXContent

org.elasticsearch.common.xcontent.XContentBuilder innerToXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                  org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                           throws java.io.IOException

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

Throws:

java.io.IOException