Package org.elasticsearch.index.rankeval
Class RankEvalSpec
- java.lang.Object
-
- org.elasticsearch.index.rankeval.RankEvalSpec
-
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
public class RankEvalSpec extends java.lang.Object implements Writeable, 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
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description RankEvalSpec(java.util.List<RatedRequest> ratedRequests, EvaluationMetric metric)
RankEvalSpec(java.util.List<RatedRequest> ratedRequests, EvaluationMetric metric, java.util.Collection<org.elasticsearch.index.rankeval.RankEvalSpec.ScriptWithId> templates)
RankEvalSpec(StreamInput in)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
int
getMaxConcurrentSearches()
Returns the max concurrent searches allowed.EvaluationMetric
getMetric()
Returns the metric to use for quality evaluation.java.util.List<RatedRequest>
getRatedRequests()
Returns a list of intent to query translation specifications to evaluate.java.util.Map<java.lang.String,Script>
getTemplates()
Returns the template to base test requests on.int
hashCode()
static RankEvalSpec
parse(XContentParser parser)
void
setMaxConcurrentSearches(int maxConcurrentSearches)
Set the max concurrent searches allowed.java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(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 Detail
-
RankEvalSpec
public RankEvalSpec(java.util.List<RatedRequest> ratedRequests, EvaluationMetric metric, java.util.Collection<org.elasticsearch.index.rankeval.RankEvalSpec.ScriptWithId> templates)
-
RankEvalSpec
public RankEvalSpec(java.util.List<RatedRequest> ratedRequests, EvaluationMetric metric)
-
RankEvalSpec
public RankEvalSpec(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
-
getMetric
public EvaluationMetric getMetric()
Returns the metric to use for quality evaluation.
-
getRatedRequests
public java.util.List<RatedRequest> getRatedRequests()
Returns a list of intent to query translation specifications to evaluate.
-
getTemplates
public java.util.Map<java.lang.String,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(XContentParser parser)
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public final boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-