Package org.hibernate.search.engine.search.predicate.dsl.spi

Class KnnPredicateFieldStepImpl

java.lang.Object

org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

org.hibernate.search.engine.search.predicate.dsl.spi.KnnPredicateFieldStepImpl

All Implemented Interfaces:

KnnPredicateFieldStep, KnnPredicateOptionsStep, KnnPredicateVectorStep, PredicateFinalStep, PredicateScoreStep<KnnPredicateOptionsStep>

public class KnnPredicateFieldStepImpl
extends AbstractPredicateFinalStep
implements KnnPredicateFieldStep, KnnPredicateVectorStep, KnnPredicateOptionsStep

Field Summary

Fields

Modifier and Type	Field	Description
protected KnnPredicateBuilder	builder

Fields inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

dslContext

Constructor Summary

Constructors

Constructor	Description
KnnPredicateFieldStepImpl(SearchPredicateFactory factory, SearchPredicateDslContext<?> dslContext, int k)

Method Summary

Modifier and Type	Method	Description
KnnPredicateOptionsStep	boost(float boost)	Boost the weight of the predicate in score computation.
protected SearchPredicate	build()
KnnPredicateOptionsStep	constantScore()	Force the score of the predicate to a single constant, identical for all documents.
KnnPredicateVectorStep	field(String fieldPath)	Target the given field in the match predicate.
KnnPredicateOptionsStep	filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)
KnnPredicateOptionsStep	filter(SearchPredicate searchPredicate)
KnnPredicateOptionsStep	matching(byte... vector)
KnnPredicateOptionsStep	matching(float... vector)
KnnPredicateOptionsStep	requiredMinimumSimilarity(float similarity)

Methods inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

toPredicate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.KnnPredicateOptionsStep

filter

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.PredicateFinalStep

toPredicate

Field Details

builder

protected KnnPredicateBuilder builder

Constructor Details

KnnPredicateFieldStepImpl

public KnnPredicateFieldStepImpl(SearchPredicateFactory factory,
 SearchPredicateDslContext<?> dslContext,
 int k)

Method Details

field

public KnnPredicateVectorStep field(String fieldPath)

Description copied from interface: KnnPredicateFieldStep

Target the given field in the match predicate.

Specified by:

field in interface KnnPredicateFieldStep

Parameters:

fieldPath - The path to the index field to apply the predicate on.

Returns:

The next step in the knn predicate DSL.

build

protected SearchPredicate build()

Specified by:

build in class AbstractPredicateFinalStep

filter

public KnnPredicateOptionsStep filter(SearchPredicate searchPredicate)

Specified by:

filter in interface KnnPredicateOptionsStep

filter

public KnnPredicateOptionsStep filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)

Specified by:

filter in interface KnnPredicateOptionsStep

matching

public KnnPredicateOptionsStep matching(byte... vector)

Specified by:

matching in interface KnnPredicateVectorStep

Parameters:

vector - The vector from which to compute the distance to vectors in the indexed field.

Returns:

The next step in the knn predicate DSL.

matching

public KnnPredicateOptionsStep matching(float... vector)

Specified by:

matching in interface KnnPredicateVectorStep

Parameters:

vector - The vector from which to compute the distance to vectors in the indexed field.

Returns:

The next step in the knn predicate DSL.

requiredMinimumSimilarity

public KnnPredicateOptionsStep requiredMinimumSimilarity(float similarity)

Specified by:

requiredMinimumSimilarity in interface KnnPredicateOptionsStep

Parameters:

similarity - A similarity limit: documents with vectors distance to which, according to the configured similarity function, is further than this limit will be filtered out from the results.

Returns:

this, for method chaining.

boost

public KnnPredicateOptionsStep boost(float boost)

Description copied from interface: PredicateScoreStep

Boost the weight of the predicate in score computation.

Specified by:

boost in interface PredicateScoreStep<KnnPredicateOptionsStep>

Parameters:

boost - The boost factor. Higher than 1 increases the weight in score computation, between 0 and 1 lowers the weight. Lower than 0 is for experts only.

Returns:

this, for method chaining.

constantScore

public KnnPredicateOptionsStep constantScore()

Description copied from interface: PredicateScoreStep

Force the score of the predicate to a single constant, identical for all documents.

By default, the score will be 1.0f, but boosts, if any, will still be applied to the predicate.

Specified by:

constantScore in interface PredicateScoreStep<KnnPredicateOptionsStep>

Returns:

this, for method chaining.