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.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
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
ConstructorDescriptionKnnScoreDocQueryBuilder
(org.apache.lucene.search.ScoreDoc[] scoreDocs, String fieldName, float[] queryVector) Creates a query builder. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
doEquals
(KnnScoreDocQueryBuilder other) Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
protected QueryBuilder
doRewrite
(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.Query
doToQuery
(SearchExecutionContext context) protected void
doWriteTo
(StreamOutput out) protected void
doXContent
(XContentBuilder builder, ToXContent.Params params) The minimal version of the recipient this object can be sent toReturns 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, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
KnnScoreDocQueryBuilder
public KnnScoreDocQueryBuilder(org.apache.lucene.search.ScoreDoc[] scoreDocs, String fieldName, float[] queryVector) 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:VersionedNamedWriteable
Returns the name of the writeable object -
scoreDocs
public org.apache.lucene.search.ScoreDoc[] scoreDocs() -
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
- Throws:
IOException
-
doXContent
- Specified by:
doXContent
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
- Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQuery
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
- Throws:
IOException
-
doRewrite
- Overrides:
doRewrite
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
- Throws:
IOException
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<KnnScoreDocQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to
-