Module org.elasticsearch.server
Package org.elasticsearch.search.vectors
Class KnnScoreDocQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<KnnScoreDocQueryBuilder>
org.elasticsearch.search.vectors.KnnScoreDocQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
A query that matches the provided docs with their scores. This query is used
when executing a kNN search during the search query phase, to include the documents
that matched the initial kNN query during the DFS phase.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionKnnScoreDocQueryBuilder(org.apache.lucene.search.ScoreDoc[] scoreDocs, String fieldName, VectorData queryVector, Float vectorSimilarity) Creates a query builder. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleandoEquals(KnnScoreDocQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderdoRewrite(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) The minimal version of the recipient this object can be sent to.Returns the name of the writeable objectorg.apache.lucene.search.ScoreDoc[]Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
KnnScoreDocQueryBuilder
public KnnScoreDocQueryBuilder(org.apache.lucene.search.ScoreDoc[] scoreDocs, String fieldName, VectorData queryVector, Float vectorSimilarity) Creates a query builder.- Parameters:
scoreDocs- the docs and scores this query should match. The array must be sorted in order of ascending doc IDs.
-
KnnScoreDocQueryBuilder
- Throws:
IOException
-
-
Method Details
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
scoreDocs
public org.apache.lucene.search.ScoreDoc[] scoreDocs() -
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<KnnScoreDocQueryBuilder>- Throws:
IOException
-
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<KnnScoreDocQueryBuilder>- Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<KnnScoreDocQueryBuilder>- Throws:
IOException
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<KnnScoreDocQueryBuilder>- Throws:
IOException
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.
-