Package org.opensearch.index.rankeval

Class RankEvalResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.index.rankeval.RankEvalResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
public class RankEvalResponse extends org.opensearch.core.action.ActionResponse implements org.opensearch.core.xcontent.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.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    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.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.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(org.opensearch.core.xcontent.XContentParser parser)
     
    Map<String,Exception>
    getFailures()
     
    double
    getMetricScore()
     
    Map<String,EvalQueryQuality>
    getPartialResults()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.opensearch.core.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.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

  • 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(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • toXContent

      public 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

    • fromXContent

      public static RankEvalResponse fromXContent(org.opensearch.core.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException