Module org.elasticsearch.server

Package org.elasticsearch.search.vectors

Class KnnSearchBuilder

java.lang.Object

org.elasticsearch.search.vectors.KnnSearchBuilder

All Implemented Interfaces:

Writeable, Rewriteable<KnnSearchBuilder>, ToXContent, ToXContentFragment

public class KnnSearchBuilder
extends Object
implements Writeable, ToXContentFragment, Rewriteable<KnnSearchBuilder>

Defines a kNN search to run in the search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnnSearchBuilder.Builder

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 ParseField	BOOST_FIELD
static final ParseField	FIELD_FIELD
static final ParseField	FILTER_FIELD
static final ParseField	INNER_HITS_FIELD
static final ParseField	K_FIELD
static final ParseField	NUM_CANDS_FIELD
static final int	NUM_CANDS_LIMIT
static final float	NUM_CANDS_MULTIPLICATIVE_FACTOR
static final ParseField	QUERY_VECTOR_BUILDER_FIELD
static final ParseField	QUERY_VECTOR_FIELD
static final ParseField	VECTOR_SIMILARITY

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
KnnSearchBuilder(String field, float[] queryVector, int k, int numCands, Float similarity)	Defines a kNN search.
KnnSearchBuilder(String field, float[] queryVector, QueryVectorBuilder queryVectorBuilder, int k, int numCands, Float similarity)
KnnSearchBuilder(String field, QueryVectorBuilder queryVectorBuilder, int k, int numCands, Float similarity)	Defines a kNN search where the query vector will be provided by the queryVectorBuilder
KnnSearchBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
KnnSearchBuilder	addFilterQueries(List<QueryBuilder> filterQueries)
KnnSearchBuilder	addFilterQuery(QueryBuilder filterQuery)
float	boost()
KnnSearchBuilder	boost(float boost)	Set a boost to apply to the kNN search scores.
boolean	equals(Object o)
static KnnSearchBuilder.Builder	fromXContent(XContentParser parser)
String	getField()
float[]	getQueryVector()
QueryVectorBuilder	getQueryVectorBuilder()
int	hashCode()
InnerHitBuilder	innerHit()
KnnSearchBuilder	innerHit(InnerHitBuilder innerHitBuilder)
int	k()
KnnSearchBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
KnnVectorQueryBuilder	toQueryBuilder()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NUM_CANDS_LIMIT

public static final int NUM_CANDS_LIMIT

See Also:

• Constant Field Values

NUM_CANDS_MULTIPLICATIVE_FACTOR

public static final float NUM_CANDS_MULTIPLICATIVE_FACTOR

See Also:

• Constant Field Values

FIELD_FIELD

public static final ParseField FIELD_FIELD

K_FIELD

public static final ParseField K_FIELD

NUM_CANDS_FIELD

public static final ParseField NUM_CANDS_FIELD

QUERY_VECTOR_FIELD

public static final ParseField QUERY_VECTOR_FIELD

QUERY_VECTOR_BUILDER_FIELD

public static final ParseField QUERY_VECTOR_BUILDER_FIELD

VECTOR_SIMILARITY

public static final ParseField VECTOR_SIMILARITY

FILTER_FIELD

public static final ParseField FILTER_FIELD

BOOST_FIELD

public static final ParseField BOOST_FIELD

INNER_HITS_FIELD

public static final ParseField INNER_HITS_FIELD

Constructor Details

KnnSearchBuilder

public KnnSearchBuilder(String field,
 float[] queryVector,
 int k,
 int numCands,
 Float similarity)

Defines a kNN search.

Parameters:

field - the name of the vector field to search against

queryVector - the query vector

k - the final number of nearest neighbors to return as top hits

numCands - the number of nearest neighbor candidates to consider per shard

KnnSearchBuilder

public KnnSearchBuilder(String field,
 QueryVectorBuilder queryVectorBuilder,
 int k,
 int numCands,
 Float similarity)

Defines a kNN search where the query vector will be provided by the queryVectorBuilder

Parameters:

field - the name of the vector field to search against

queryVectorBuilder - the query vector builder

k - the final number of nearest neighbors to return as top hits

numCands - the number of nearest neighbor candidates to consider per shard

KnnSearchBuilder

public KnnSearchBuilder(String field,
 float[] queryVector,
 QueryVectorBuilder queryVectorBuilder,
 int k,
 int numCands,
 Float similarity)

KnnSearchBuilder

public KnnSearchBuilder(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

fromXContent

public static KnnSearchBuilder.Builder fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException

k

public int k()

getQueryVectorBuilder

public QueryVectorBuilder getQueryVectorBuilder()

getQueryVector

public float[] getQueryVector()

getField

public String getField()

addFilterQuery

public KnnSearchBuilder addFilterQuery(QueryBuilder filterQuery)

addFilterQueries

public KnnSearchBuilder addFilterQueries(List<QueryBuilder> filterQueries)

boost

public KnnSearchBuilder boost(float boost)

Set a boost to apply to the kNN search scores.

boost

public float boost()

innerHit

public KnnSearchBuilder innerHit(InnerHitBuilder innerHitBuilder)

innerHit

public InnerHitBuilder innerHit()

rewrite

public KnnSearchBuilder rewrite(QueryRewriteContext ctx)
                         throws IOException

Description copied from interface: Rewriteable

Rewrites 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:

rewrite in interface Rewriteable<KnnSearchBuilder>

Throws:

IOException

toQueryBuilder

public KnnVectorQueryBuilder toQueryBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException