Package org.opensearch.index.rankeval

Interface MetricDetail

All Superinterfaces:
NamedWriteable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, Writeable
All Known Implementing Classes:
DiscountedCumulativeGain.Detail, ExpectedReciprocalRank.Detail, MeanReciprocalRank.Detail, PrecisionAtK.Detail, RecallAtK.Detail
public interface MetricDetail extends org.opensearch.core.xcontent.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.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

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

  • Field Summary

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

    EMPTY_PARAMS

  • Method Summary

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

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

    getWriteableName

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

    isFragment

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

    writeTo

  • Method Details

    • toXContent

      default org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • getMetricName

      default String getMetricName()

    • innerToXContent

      org.opensearch.core.xcontent.XContentBuilder innerToXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Implementations should write their own fields to the XContentBuilder passed in.
      Throws:
      IOException