org.apache.ignite.cache.query

Class VectorQuery<K,V>

java.lang.Object

org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<K,V>>

org.apache.ignite.cache.query.VectorQuery<K,V>

All Implemented Interfaces:

Serializable

public final class VectorQuery<K,V>
extends Query<javax.cache.Cache.Entry<K,V>>

Vector queries based on Apache Lucene engine.

Description

Ignite supports vector queries based on Apache Lucene engine. Note that all fields that are expected to show up in vector query results must be annotated with QueryVectorField and be of type float[].

Query usage

As an example, suppose we have data model consisting of 'Person' class defined as follows:

 public class Person {
     private long id;

     private String name;

     // Index for vector search.
     @QueryVectorField
     private float[] resume;
     ...
 }
 

Here is a possible query that will use Lucene vector search to scan all resumes to check if employees have Master degree:

 Query<Cache.Entry<Long, Person>> qry =
     new VectorQuery(Person.class, "resume", toEmbedding("Master"), 1);

 // Query all cache nodes.
 cache.query(qry).getAll();

 Where toEmbedding is a function that converts text to vector with the transformer
 and 1 is the number of vectors to return.
 

See Also:

IgniteCache.query(Query), Serialized Form

Field Summary

Fields inherited from class org.apache.ignite.cache.query.Query

DFLT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
VectorQuery(Class<?> type, String field, float[] clauseVector, int k) Constructs query for the given search vector.
VectorQuery(Class<?> type, String field, float[] clauseVector, int k, float threshold) Constructs query for the given search vector.
VectorQuery(String type, String field, float[] clauseVector, int k) Constructs query for the given search string.
VectorQuery(String type, String field, float[] clauseVector, int k, float threshold) Constructs query for the given search string.

Method Summary

Modifier and Type	Method and Description
float[]	getClauseVector() Gets search vector.
String	getField() Gets field for query.
int	getK() Gets k (the number of vectors to return).
float	getThreshold() Gets k (the number of vectors to return).
String	getType() Gets type for query.
VectorQuery<K,V>	setClauseVector(float[] clauseVector) Sets text search vector.
VectorQuery<K,V>	setField(String field) Sets field for query.
VectorQuery<K,V>	setK(int k) Sets k (the number of vectors to return).
VectorQuery<K,V>	setLocal(boolean loc) Sets whether this query should be executed on local node only.
VectorQuery<K,V>	setPageSize(int pageSize) Sets optional page size, if 0, then default is used.
VectorQuery<K,V>	setThreshold(float threshold) Sets k (the number of vectors to return).
VectorQuery<K,V>	setType(Class<?> type) Sets type for query.
VectorQuery<K,V>	setType(String type) Sets type for query.
String	toString()

Methods inherited from class org.apache.ignite.cache.query.Query

getPageSize, isLocal, prepare

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VectorQuery

public VectorQuery(Class<?> type,
                   String field,
                   float[] clauseVector,
                   int k)

Constructs query for the given search vector.

Parameters:

type - Type.

field - Type.

clauseVector - Search vector.

k - The number of vectors to return.

VectorQuery

public VectorQuery(Class<?> type,
                   String field,
                   float[] clauseVector,
                   int k,
                   float threshold)

Constructs query for the given search vector.

Parameters:

type - Type.

field - Type.

clauseVector - Search vector.

k - The number of vectors to return.

threshold - The threshold for similarity.

VectorQuery

public VectorQuery(String type,
                   String field,
                   float[] clauseVector,
                   int k)

Constructs query for the given search string.

Parameters:

type - Type.

field - Type.

clauseVector - Search string.

k - The number of vectors to return.

VectorQuery

public VectorQuery(String type,
                   String field,
                   float[] clauseVector,
                   int k,
                   float threshold)

Constructs query for the given search string.

Parameters:

type - Type.

field - Type.

clauseVector - Search string.

k - The number of vectors to return.

threshold - The threshold for similarity.

Method Detail

getType

public String getType()

Gets type for query.

Returns:

Type.

setType

public VectorQuery<K,V> setType(String type)

Sets type for query.

Parameters:

type - Type.

Returns:

this For chaining.

setType

public VectorQuery<K,V> setType(Class<?> type)

Sets type for query.

Parameters:

type - Type.

Returns:

this For chaining.

setK

public VectorQuery<K,V> setK(int k)

Sets k (the number of vectors to return).

Parameters:

k - K.

Returns:

this For chaining.

getK

public int getK()

Gets k (the number of vectors to return).

Returns:

K.

setThreshold

public VectorQuery<K,V> setThreshold(float threshold)

Sets k (the number of vectors to return).

Parameters:

threshold - threshold.

Returns:

this For chaining.

getThreshold

public float getThreshold()

Gets k (the number of vectors to return).

Returns:

K.

getField

public String getField()

Gets field for query.

Returns:

Type.

setField

public VectorQuery<K,V> setField(String field)

Sets field for query.

Parameters:

field - field.

Returns:

this For chaining.

getClauseVector

public float[] getClauseVector()

Gets search vector.

Returns:

Search vector.

setClauseVector

public VectorQuery<K,V> setClauseVector(float[] clauseVector)

Sets text search vector.

Parameters:

clauseVector - Text search string as vector.

Returns:

this For chaining.

setPageSize

public VectorQuery<K,V> setPageSize(int pageSize)

Sets optional page size, if 0, then default is used.

Overrides:

setPageSize in class Query<javax.cache.Cache.Entry<K,V>>

Parameters:

pageSize - Optional page size.

Returns:

this for chaining.

setLocal

public VectorQuery<K,V> setLocal(boolean loc)

Sets whether this query should be executed on local node only.

Overrides:

setLocal in class Query<javax.cache.Cache.Entry<K,V>>

Parameters:

loc - Local flag.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Query<javax.cache.Cache.Entry<K,V>>