Package org.elasticsearch.index.rankeval

Class RankEvalSpec

java.lang.Object
org.elasticsearch.index.rankeval.RankEvalSpec
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class RankEvalSpec extends Object implements org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Specification of the ranking evaluation request.
This class groups the queries to evaluate, including their document ratings, and the evaluation metric including its parameters.

  • 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 Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RankEvalSpec​(List<RatedRequest> ratedRequests, EvaluationMetric metric)
     
    RankEvalSpec​(List<RatedRequest> ratedRequests, EvaluationMetric metric, Collection<org.elasticsearch.index.rankeval.RankEvalSpec.ScriptWithId> templates)
     
    RankEvalSpec​(org.elasticsearch.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
    int
    getMaxConcurrentSearches()
    Returns the max concurrent searches allowed.
    EvaluationMetric
    getMetric()
    Returns the metric to use for quality evaluation.
    List<RatedRequest>
    getRatedRequests()
    Returns a list of intent to query translation specifications to evaluate.
    Map<String,​org.elasticsearch.script.Script>
    getTemplates()
    Returns the template to base test requests on.
    int
    hashCode()
     
    static RankEvalSpec
    parse​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    void
    setMaxConcurrentSearches​(int maxConcurrentSearches)
    Set the max concurrent searches allowed.
    String
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

    isFragment

  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.elasticsearch.common.io.stream.Writeable
      Throws:
      IOException

    • getMetric

      public EvaluationMetric getMetric()
      Returns the metric to use for quality evaluation.

    • getRatedRequests

      public List<RatedRequest> getRatedRequests()
      Returns a list of intent to query translation specifications to evaluate.

    • getTemplates

      public Map<String,​org.elasticsearch.script.Script> getTemplates()
      Returns the template to base test requests on.

    • getMaxConcurrentSearches

      public int getMaxConcurrentSearches()
      Returns the max concurrent searches allowed.

    • setMaxConcurrentSearches

      public void setMaxConcurrentSearches​(int maxConcurrentSearches)
      Set the max concurrent searches allowed.

    • parse

      public static RankEvalSpec parse​(org.elasticsearch.common.xcontent.XContentParser parser)

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public final boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object