Package org.opensearch.index.rankeval
Class RankEvalSpec
java.lang.Object
org.opensearch.index.rankeval.RankEvalSpec
- All Implemented Interfaces:
Writeable,ToXContent,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.
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.opensearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object> -
Field Summary
Fields inherited from interface org.opensearch.common.xcontent.ToXContent
EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionRankEvalSpec(List<RatedRequest> ratedRequests, EvaluationMetric metric) RankEvalSpec(List<RatedRequest> ratedRequests, EvaluationMetric metric, Collection<org.opensearch.index.rankeval.RankEvalSpec.ScriptWithId> templates) -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanintReturns the max concurrent searches allowed.Returns the metric to use for quality evaluation.Returns a list of intent to query translation specifications to evaluate.Returns the template to base test requests on.final inthashCode()static RankEvalSpecparse(XContentParser parser) voidsetMaxConcurrentSearches(int maxConcurrentSearches) Set the max concurrent searches allowed.toString()toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.opensearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
RankEvalSpec
public RankEvalSpec(List<RatedRequest> ratedRequests, EvaluationMetric metric, Collection<org.opensearch.index.rankeval.RankEvalSpec.ScriptWithId> templates) -
RankEvalSpec
-
RankEvalSpec
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
getMetric
Returns the metric to use for quality evaluation. -
getRatedRequests
Returns a list of intent to query translation specifications to evaluate. -
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
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
toString
-
equals
-
hashCode
public final int hashCode()
-