Module org.elasticsearch.server

Package org.elasticsearch.search.retriever

Class KnnRetrieverBuilder

java.lang.Object

org.elasticsearch.search.retriever.RetrieverBuilder

org.elasticsearch.search.retriever.KnnRetrieverBuilder

All Implemented Interfaces:

Rewriteable<RetrieverBuilder>, ToXContent

public final class KnnRetrieverBuilder
extends RetrieverBuilder

A knn retriever is used to represent a knn search with some elements to specify parameters for that knn search.

Nested Class Summary

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 ParseField	FIELD_FIELD
static final ParseField	K_FIELD
static final NodeFeature	KNN_RETRIEVER_SUPPORTED
static final String	NAME
static final ParseField	NUM_CANDS_FIELD
static final ConstructingObjectParser<KnnRetrieverBuilder,RetrieverParserContext>	PARSER
static final ParseField	QUERY_VECTOR_BUILDER_FIELD
static final ParseField	QUERY_VECTOR_FIELD
static final ParseField	RESCORE_VECTOR_FIELD
static final ParseField	VECTOR_SIMILARITY

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

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

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
KnnRetrieverBuilder(String field, float[] queryVector, QueryVectorBuilder queryVectorBuilder, int k, int numCands, RescoreVectorBuilder rescoreVectorBuilder, Float similarity)

Method Summary

Modifier and Type	Method	Description
boolean	doEquals(Object o)
int	doHashCode()
void	doToXContent(XContentBuilder builder, ToXContent.Params params)
QueryBuilder	explainQuery()
void	extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed)	This method is called at the end of rewriting on behalf of a SearchSourceBuilder.
static KnnRetrieverBuilder	fromXContent(XContentParser parser, RetrieverParserContext context)
String	getName()
RetrieverBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
QueryBuilder	topDocsQuery()	This function is called by compound RetrieverBuilder to 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

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

KNN_RETRIEVER_SUPPORTED

public static final NodeFeature KNN_RETRIEVER_SUPPORTED

FIELD_FIELD

public static final ParseField FIELD_FIELD

K_FIELD

public static final ParseField K_FIELD

NUM_CANDS_FIELD

public static final ParseField NUM_CANDS_FIELD

QUERY_VECTOR_FIELD

public static final ParseField QUERY_VECTOR_FIELD

QUERY_VECTOR_BUILDER_FIELD

public static final ParseField QUERY_VECTOR_BUILDER_FIELD

VECTOR_SIMILARITY

public static final ParseField VECTOR_SIMILARITY

RESCORE_VECTOR_FIELD

public static final ParseField RESCORE_VECTOR_FIELD

PARSER

public static final ConstructingObjectParser<KnnRetrieverBuilder,RetrieverParserContext> PARSER

Constructor Details

KnnRetrieverBuilder

public KnnRetrieverBuilder(String field,
 float[] queryVector,
 QueryVectorBuilder queryVectorBuilder,
 int k,
 int numCands,
 RescoreVectorBuilder rescoreVectorBuilder,
 Float similarity)

Method Details

fromXContent

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

Throws:

IOException

getName

public String getName()

Specified by:

getName in class RetrieverBuilder

rewrite

public RetrieverBuilder rewrite(QueryRewriteContext ctx)
                         throws IOException

Description copied from interface: Rewriteable

Rewrites 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:

rewrite in interface Rewriteable<RetrieverBuilder>

Overrides:

rewrite in class RetrieverBuilder

Throws:

IOException

topDocsQuery

public QueryBuilder topDocsQuery()

Description copied from class: RetrieverBuilder

This function is called by compound RetrieverBuilder to return the original query that was used by this retriever to compute its top documents.

Specified by:

topDocsQuery in class RetrieverBuilder

explainQuery

public QueryBuilder explainQuery()

Overrides:

explainQuery in class RetrieverBuilder

extractToSearchSourceBuilder

public void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder,
 boolean compoundUsed)

Description copied from class: RetrieverBuilder

This method is called at the end of rewriting on behalf of a SearchSourceBuilder. Elements from retrievers are expected to be "extracted" into the SearchSourceBuilder.

Specified by:

extractToSearchSourceBuilder in class RetrieverBuilder

doToXContent

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

Specified by:

doToXContent in class RetrieverBuilder

Throws:

IOException

doEquals

public boolean doEquals(Object o)

Specified by:

doEquals in class RetrieverBuilder

doHashCode

public int doHashCode()

Specified by:

doHashCode in class RetrieverBuilder