com.couchbase.client.java.search.vector

Class VectorQuery

java.lang.Object

com.couchbase.client.java.search.vector.VectorQuery

@Stability.Uncommitted
public class VectorQuery
extends Object

Method Summary

Modifier and Type	Method and Description
VectorQuery	boost(double boost) Can be used to control how much weight to give the results of this query vs other queries.
static VectorQuery	create(String vectorField, float[] vectorQuery)
VectorQuery	numCandidates(int numCandidates) This is the number of results that will be returned from this vector query.
com.couchbase.client.core.api.search.vector.CoreVectorQuery	toCore()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static VectorQuery create(String vectorField,
                                 float[] vectorQuery)

Parameters:

vectorField - the document field that contains the vector.

vectorQuery - the vector query to run.

Returns:

numCandidates

public VectorQuery numCandidates(int numCandidates)

This is the number of results that will be returned from this vector query.

Returns:

this, for chaining.

boost

public VectorQuery boost(double boost)

Can be used to control how much weight to give the results of this query vs other queries. See the FTS documentation for details.

Returns:

this, for chaining.

toCore

@Stability.Internal
public com.couchbase.client.core.api.search.vector.CoreVectorQuery toCore()