Class RankEvalResponse.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.RankEvalResponse.Builder
- All Implemented Interfaces:
CopyableBuilder<RankEvalResponse.Builder,,RankEvalResponse> MutableBuilder<RankEvalResponse.Builder,,RankEvalResponse> ObjectBuilder<RankEvalResponse>
- Enclosing class:
RankEvalResponse
public static class RankEvalResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RankEvalResponse.Builder,RankEvalResponse>
Builder for
RankEvalResponse.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aRankEvalResponse.copy()Create a new builderCopyableBuilderthat is a copy of this one.final RankEvalResponse.BuilderRequired - The details section contains one entry for every query in the original requests section, keyed by the search request idfinal RankEvalResponse.Builderdetails(String key, RankEvalMetricDetail value) Required - The details section contains one entry for every query in the original requests section, keyed by the search request idfinal RankEvalResponse.Builderdetails(Map<String, RankEvalMetricDetail> map) Required - The details section contains one entry for every query in the original requests section, keyed by the search request idfinal RankEvalResponse.BuilderRequired - API name:failuresfinal RankEvalResponse.BuilderRequired - API name:failuresfinal RankEvalResponse.BuildermetricScore(double value) Required - The overall evaluation quality calculated by the defined metricMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<RankEvalResponse.Builder,RankEvalResponse> - Returns:
- a new builder instance.
-
details
Required - The details section contains one entry for every query in the original requests section, keyed by the search request idAPI name:
detailsAdds all elements of
maptodetails. -
details
Required - The details section contains one entry for every query in the original requests section, keyed by the search request idAPI name:
detailsAdds an entry to
details. -
details
@Nonnull public final RankEvalResponse.Builder details(String key, Function<RankEvalMetricDetail.Builder, ObjectBuilder<RankEvalMetricDetail>> fn) Required - The details section contains one entry for every query in the original requests section, keyed by the search request idAPI name:
detailsAdds a value to
detailsusing a builder lambda. -
failures
Required - API name:failuresAdds all elements of
maptofailures. -
failures
Required - API name:failuresAdds an entry to
failures. -
metricScore
Required - The overall evaluation quality calculated by the defined metricAPI name:
metric_score -
build
Builds aRankEvalResponse.- Specified by:
buildin interfaceObjectBuilder<RankEvalResponse>- Throws:
NullPointerException- if some of the required fields are null.
-