Module org.elasticsearch.server

Package org.elasticsearch.search.vectors

Class KnnScoreDocQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<KnnScoreDocQueryBuilder>

org.elasticsearch.index.query.LeafQueryBuilder<KnnScoreDocQueryBuilder>

org.elasticsearch.search.vectors.KnnScoreDocQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class KnnScoreDocQueryBuilder
extends LeafQueryBuilder<KnnScoreDocQueryBuilder>

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

Modifier and Type	Field	Description
static final String	NAME

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

Constructors

Constructor	Description
KnnScoreDocQueryBuilder(org.apache.lucene.search.ScoreDoc[] scoreDocs, String fieldName, VectorData queryVector, Float vectorSimilarity, List<QueryBuilder> filterQueries)	Creates a query builder.
KnnScoreDocQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(KnnScoreDocQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
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)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
String	getWriteableName()	Returns the name of the writeable object
org.apache.lucene.search.ScoreDoc[]	scoreDocs()

Methods inherited from class org.elasticsearch.index.query.LeafQueryBuilder

doToQuery

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, 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

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

KnnScoreDocQueryBuilder

public KnnScoreDocQueryBuilder(org.apache.lucene.search.ScoreDoc[] scoreDocs,
 String fieldName,
 VectorData queryVector,
 Float vectorSimilarity,
 List<QueryBuilder> filterQueries)

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

public KnnScoreDocQueryBuilder(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

scoreDocs

public org.apache.lucene.search.ScoreDoc[] scoreDocs()

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<KnnScoreDocQueryBuilder>

Throws:

IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<KnnScoreDocQueryBuilder>

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class LeafQueryBuilder<KnnScoreDocQueryBuilder>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<KnnScoreDocQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(KnnScoreDocQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<KnnScoreDocQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<KnnScoreDocQueryBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.