Module org.elasticsearch.server

Package org.elasticsearch.search.vectors

Class KnnVectorQueryBuilder

java.lang.Object

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

org.elasticsearch.search.vectors.KnnVectorQueryBuilder

All Implemented Interfaces:

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

public class KnnVectorQueryBuilder
extends AbstractQueryBuilder<KnnVectorQueryBuilder>

A query that performs kNN search using Lucene's KnnFloatVectorQuery or KnnByteVectorQuery. NOTE: this is an internal class and should not be used outside of core Elasticsearch code.

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
KnnVectorQueryBuilder(String fieldName, byte[] queryVector, int numCands, Float vectorSimilarity)
KnnVectorQueryBuilder(String fieldName, float[] queryVector, int numCands, Float vectorSimilarity)
KnnVectorQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
KnnVectorQueryBuilder	addFilterQueries(List<QueryBuilder> filterQueries)
KnnVectorQueryBuilder	addFilterQuery(QueryBuilder filterQuery)
protected boolean	doEquals(KnnVectorQueryBuilder 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)
List<QueryBuilder>	filterQueries()
byte[]	getByteQueryVector()
String	getFieldName()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
Float	getVectorSimilarity()
String	getWriteableName()	Returns the name of the writeable object
int	numCands()
float[]	queryVector()

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, 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

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

KnnVectorQueryBuilder

public KnnVectorQueryBuilder(String fieldName,
 float[] queryVector,
 int numCands,
 Float vectorSimilarity)

KnnVectorQueryBuilder

public KnnVectorQueryBuilder(String fieldName,
 byte[] queryVector,
 int numCands,
 Float vectorSimilarity)

KnnVectorQueryBuilder

public KnnVectorQueryBuilder(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

getFieldName

public String getFieldName()

queryVector

@Nullable
public float[] queryVector()

getByteQueryVector

@Nullable
public byte[] getByteQueryVector()

getVectorSimilarity

@Nullable
public Float getVectorSimilarity()

numCands

public int numCands()

filterQueries

public List<QueryBuilder> filterQueries()

addFilterQuery

public KnnVectorQueryBuilder addFilterQuery(QueryBuilder filterQuery)

addFilterQueries

public KnnVectorQueryBuilder addFilterQueries(List<QueryBuilder> filterQueries)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<KnnVectorQueryBuilder>

Throws:

IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<KnnVectorQueryBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<KnnVectorQueryBuilder>

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<KnnVectorQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<KnnVectorQueryBuilder>

doEquals

protected boolean doEquals(KnnVectorQueryBuilder 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<KnnVectorQueryBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to