Module org.elasticsearch.server

Package org.elasticsearch.search.diversification

Class DiversifyRetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

org.elasticsearch.search.retriever.CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

org.elasticsearch.search.diversification.DiversifyRetrieverBuilder

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

public final class DiversifyRetrieverBuilder
extends CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiversifyRetrieverBuilder.RankDocWithSearchHit

Nested classes/interfaces inherited from class org.elasticsearch.search.retriever.CompoundRetrieverBuilder

CompoundRetrieverBuilder.RetrieverSource

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Float	DEFAULT_LAMBDA_VALUE
static final int	DEFAULT_SIZE_VALUE
static final ParseField	FIELD_FIELD
static final ParseField	LAMBDA_FIELD
static final String	NAME
static final ParseField	QUERY_VECTOR_FIELD
static final ParseField	RETRIEVER_FIELD
static final NodeFeature	RETRIEVER_RESULT_DIVERSIFICATION_MMR_FEATURE
static final ParseField	SIZE_FIELD
static final ParseField	TYPE_FIELD

Fields inherited from class org.elasticsearch.search.retriever.CompoundRetrieverBuilder

INNER_RETRIEVERS_FILTER_SUPPORT, innerRetrievers, RANK_WINDOW_SIZE_FIELD, rankWindowSize

Fields inherited from class org.elasticsearch.search.retriever.RetrieverBuilder

MIN_SCORE_FIELD, minScore, NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, rankDocs, retrieverName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected DiversifyRetrieverBuilder	clone(List<CompoundRetrieverBuilder.RetrieverSource> newChildRetrievers, List<QueryBuilder> newPreFilterQueryBuilders)	Returns a clone of the original retriever, replacing the sub-retrievers with the provided newChildRetrievers and the filters with the newPreFilterQueryBuilders.
protected RankDoc[]	combineInnerRetrieverResults(List<org.apache.lucene.search.ScoreDoc[]> rankResults, boolean explain)	Combines the provided rankResults to return the final top documents.
protected RankDoc	createRankDocFromHit(int docId, SearchHit hit, int shardRequestIndex)	Overridable method to create the rank doc for the result set.
boolean	doEquals(Object o)
protected RetrieverBuilder	doRewrite(QueryRewriteContext ctx)	Perform any custom rewrite logic necessary
protected void	doToXContent(XContentBuilder builder, ToXContent.Params params)
protected SearchSourceBuilder	finalizeSourceBuilder(SearchSourceBuilder sourceBuilder)
static DiversifyRetrieverBuilder	fromXContent(XContentParser parser, RetrieverParserContext context)
String	getName()
protected Exception	processInnerItemFailureException(Exception ex)	Overridable method to check or modify any failures from child retrievers if needed
ActionRequestValidationException	validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults)

Methods inherited from class org.elasticsearch.search.retriever.CompoundRetrieverBuilder

addChild, createSearchSourceBuilder, doHashCode, explainQuery, extractToSearchSourceBuilder, getRankWindowSizeField, innerRetrievers, isCompound, rankWindowSize, rewrite, topDocsQuery

Methods inherited from class org.elasticsearch.search.retriever.RetrieverBuilder

declareBaseParserFields, equals, getExtendedUsageFields, getPreFilterQueryBuilders, getRankDocs, hashCode, isFragment, minScore, minScore, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, retrieverName, retrieverName, rewritePreFilters, setRankDocs, toString, toXContent

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LAMBDA_VALUE

public static final Float DEFAULT_LAMBDA_VALUE

DEFAULT_SIZE_VALUE

public static final int DEFAULT_SIZE_VALUE

See Also:

• Constant Field Values

RETRIEVER_RESULT_DIVERSIFICATION_MMR_FEATURE

public static final NodeFeature RETRIEVER_RESULT_DIVERSIFICATION_MMR_FEATURE

NAME

public static final String NAME

See Also:

• Constant Field Values

RETRIEVER_FIELD

public static final ParseField RETRIEVER_FIELD

TYPE_FIELD

public static final ParseField TYPE_FIELD

FIELD_FIELD

public static final ParseField FIELD_FIELD

QUERY_VECTOR_FIELD

public static final ParseField QUERY_VECTOR_FIELD

LAMBDA_FIELD

public static final ParseField LAMBDA_FIELD

SIZE_FIELD

public static final ParseField SIZE_FIELD

Method Details

clone

protected DiversifyRetrieverBuilder clone(List<CompoundRetrieverBuilder.RetrieverSource> newChildRetrievers,
 List<QueryBuilder> newPreFilterQueryBuilders)

Description copied from class: CompoundRetrieverBuilder

Returns a clone of the original retriever, replacing the sub-retrievers with the provided newChildRetrievers and the filters with the newPreFilterQueryBuilders.

Specified by:

clone in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

validate

public ActionRequestValidationException validate(SearchSourceBuilder source,
 ActionRequestValidationException validationException,
 boolean isScroll,
 boolean allowPartialSearchResults)

Overrides:

validate in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

doRewrite

protected RetrieverBuilder doRewrite(QueryRewriteContext ctx)

Description copied from class: CompoundRetrieverBuilder

Perform any custom rewrite logic necessary

Overrides:

doRewrite in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

Parameters:

ctx - The query rewrite context

Returns:

RetrieverBuilder the rewritten retriever

finalizeSourceBuilder

protected SearchSourceBuilder finalizeSourceBuilder(SearchSourceBuilder sourceBuilder)

Overrides:

finalizeSourceBuilder in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

processInnerItemFailureException

protected Exception processInnerItemFailureException(Exception ex)

Description copied from class: CompoundRetrieverBuilder

Overridable method to check or modify any failures from child retrievers if needed

Overrides:

processInnerItemFailureException in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

Parameters:

ex - the exception thrown

Returns:

the failure exception

combineInnerRetrieverResults

protected RankDoc[] combineInnerRetrieverResults(List<org.apache.lucene.search.ScoreDoc[]> rankResults,
 boolean explain)

Description copied from class: CompoundRetrieverBuilder

Combines the provided rankResults to return the final top documents.

Specified by:

combineInnerRetrieverResults in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

getName

public String getName()

Specified by:

getName in class RetrieverBuilder

fromXContent

public static DiversifyRetrieverBuilder fromXContent(XContentParser parser,
 RetrieverParserContext context)
                                              throws IOException

Throws:

IOException

doToXContent

protected void doToXContent(XContentBuilder builder,
 ToXContent.Params params)
                     throws IOException

Specified by:

doToXContent in class RetrieverBuilder

Throws:

IOException

createRankDocFromHit

protected RankDoc createRankDocFromHit(int docId,
 SearchHit hit,
 int shardRequestIndex)

Description copied from class: CompoundRetrieverBuilder

Overridable method to create the rank doc for the result set.

Overrides:

createRankDocFromHit in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>

Parameters:

docId - the decoded docId

hit - the SearchHit object

shardRequestIndex - the shared request index

Returns:

a RankDoc (or subclass)

doEquals

public boolean doEquals(Object o)

Overrides:

doEquals in class CompoundRetrieverBuilder<DiversifyRetrieverBuilder>