case class VectorQuery(vectorQuery: Either[Array[Float], String], vectorField: String, numCandidates: Option[Int] = None, prefilter: Option[SearchQuery] = None, boost: Option[Double] = None) extends Product with Serializable
Represents a vector query.
- Alphabetic
- By Inheritance
- VectorQuery
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new VectorQuery(vectorQuery: Either[Array[Float], String], vectorField: String, numCandidates: Option[Int] = None, prefilter: Option[SearchQuery] = None, boost: Option[Double] = None)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def boost(boost: Double): VectorQuery
Can be used to control how much weight to give the results of this query vs other queries.
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
a copy of this, for chaining.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def numCandidates(numCandidates: Int): VectorQuery
This is the number of results that will be returned from this vector query.
This is the number of results that will be returned from this vector query.
- returns
a copy of this, for chaining.
- def prefilter(prefilter: SearchQuery): VectorQuery
This is the prefilter query.
This is the prefilter query.
The server first executes this non-vector query to get an intermediate result. Then it executes the vector query on the intermediate result to get the final result.
If no prefilter is specified, the server executes the vector query on all indexed documents.
- returns
a copy of this, for chaining.
- Annotations
- @SinceCouchbase()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)