Module org.elasticsearch.server
Class KnnRetrieverBuilder
java.lang.Object
org.elasticsearch.search.retriever.RetrieverBuilder
org.elasticsearch.search.retriever.KnnRetrieverBuilder
- All Implemented Interfaces:
Rewriteable<RetrieverBuilder>,ToXContent
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
FieldsModifier and TypeFieldDescriptionstatic final ParseFieldstatic final ParseFieldstatic final Stringstatic final ParseFieldstatic final ParseFieldstatic final ParseFieldstatic final ParseFieldstatic final ParseFieldFields inherited from class org.elasticsearch.search.retriever.RetrieverBuilder
MIN_SCORE_FIELD, minScore, NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, rankDocs, retrieverNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionKnnRetrieverBuilder(String field, float[] queryVector, QueryVectorBuilder queryVectorBuilder, int k, int numCands, RescoreVectorBuilder rescoreVectorBuilder, Float similarity) -
Method Summary
Modifier and TypeMethodDescriptionbooleanintvoiddoToXContent(XContentBuilder builder, ToXContent.Params params) voidextractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed) This method is called at the end of rewriting on behalf of aSearchSourceBuilder.static KnnRetrieverBuilderfromXContent(XContentParser parser, RetrieverParserContext context) 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:
-
FIELD_FIELD
-
K_FIELD
-
NUM_CANDS_FIELD
-
QUERY_VECTOR_FIELD
-
QUERY_VECTOR_BUILDER_FIELD
-
VECTOR_SIMILARITY
-
RESCORE_VECTOR_FIELD
-
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
- 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
-
doToXContent
- Specified by:
doToXContentin classRetrieverBuilder- Throws:
IOException
-
doEquals
- Specified by:
doEqualsin classRetrieverBuilder
-
doHashCode
public int doHashCode()- Specified by:
doHashCodein classRetrieverBuilder
-