Package org.ametys.plugins.ai.search

Class VectorQuery

java.lang.Object

org.ametys.plugins.ai.search.VectorQuery

All Implemented Interfaces:

Query

public class VectorQuery
extends Object
implements Query

An embedding-based query, which can be used to perform a vector search (solr knn query).

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields inherited from interface org.ametys.cms.search.query.Query

BOOL_FILTER, BOOL_MUST, BOOL_MUST_NOT, BOOL_SHOULD

Constructor Summary

Constructors

Constructor	Description
VectorQuery(String fieldName, List<Float> vector)	Create a vector query with the given field name and vector, and a default of minReturn of 0.7.
VectorQuery(String fieldName, List<Float> vector, double minReturn)	Create a vector query with the given field name and vector, and a default topK of 10.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
Optional<Object>	buildAsJson()	Build the solr query representing the Query object. The return type may be either String or Map<String, Object> following the Solr JSON Query DSL.
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.query.Query

rewrite, toString

Constructor Details

VectorQuery

public VectorQuery(String fieldName,
 List<Float> vector)

Create a vector query with the given field name and vector, and a default of minReturn of 0.7.

Parameters:

fieldName - the name of the field to search on

vector - the vector to search with

VectorQuery

public VectorQuery(String fieldName,
 List<Float> vector,
 double minReturn)

Create a vector query with the given field name and vector, and a default topK of 10.

Parameters:

fieldName - the name of the field to search on

vector - the vector to search with

minReturn - the min return value for the vector similarity query (between 0 and 1, default is 0.7)

Method Details

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Specified by:

build in interface Query

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

buildAsJson

public Optional<Object> buildAsJson()
                             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query representing the Query object.
The return type may be either String or Map<String, Object> following the Solr JSON Query DSL.

Specified by:

buildAsJson in interface Query

Returns:

the solr query representing the Query object. Can be empty in case of empty query.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object