Module org.elasticsearch.server
Class RankDocsRetrieverBuilder
java.lang.Object
org.elasticsearch.search.retriever.RetrieverBuilder
org.elasticsearch.search.retriever.RankDocsRetrieverBuilder
- All Implemented Interfaces:
Rewriteable<RetrieverBuilder>,ToXContent
An
RetrieverBuilder that is used to retrieve documents based on the rank of the documents.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.retriever.RetrieverBuilder
MIN_SCORE_FIELD, minScore, NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, retrieverName, RETRIEVERS_SUPPORTEDFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionRankDocsRetrieverBuilder(int rankWindowSize, List<RetrieverBuilder> sources, Supplier<RankDoc[]> rankDocs, Float minScore) -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanprotected intprotected voiddoToXContent(XContentBuilder builder, ToXContent.Params params) voidextractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed) This method is called at the end of rewriting on behalf of aSearchSourceBuilder.getName()Rewrites this instance based on the provided context.This function is called by compoundRetrieverBuilderto return the original query that was used by this retriever to compute its top documents.Methods inherited from class org.elasticsearch.search.retriever.RetrieverBuilder
declareBaseParserFields, equals, getPreFilterQueryBuilders, getRankDocs, hashCode, isCompound, isFragment, minScore, minScore, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, retrieverName, retrieverName, rewritePreFilters, setRankDocs, toString, toXContent, validate
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
RankDocsRetrieverBuilder
public RankDocsRetrieverBuilder(int rankWindowSize, List<RetrieverBuilder> sources, Supplier<RankDoc[]> rankDocs, Float minScore)
-
-
Method Details
-
getName
- Specified by:
getNamein classRetrieverBuilder
-
rewrite
Description copied from interface:RewriteableRewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.- Specified by:
rewritein interfaceRewriteable<RetrieverBuilder>- Overrides:
rewritein classRetrieverBuilder- Throws:
IOException
-
topDocsQuery
Description copied from class:RetrieverBuilderThis function is called by compoundRetrieverBuilderto return the original query that was used by this retriever to compute its top documents.- Specified by:
topDocsQueryin classRetrieverBuilder
-
explainQuery
- Overrides:
explainQueryin classRetrieverBuilder
-
extractToSearchSourceBuilder
public void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed) Description copied from class:RetrieverBuilderThis method is called at the end of rewriting on behalf of aSearchSourceBuilder. Elements from retrievers are expected to be "extracted" into theSearchSourceBuilder.- Specified by:
extractToSearchSourceBuilderin classRetrieverBuilder
-
doEquals
- Specified by:
doEqualsin classRetrieverBuilder
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classRetrieverBuilder
-
doToXContent
- Specified by:
doToXContentin classRetrieverBuilder- Throws:
IOException
-