SCBC-461: Support for base64 encoded vector types

CBD-5903: SDK API 3.6 Release Preparation

Supporting base64 vectors, and bumping vector search in
general to Committed level.

Change-Id: Id93f9e5b5329d171695318a48f4ca2639e48eec8
Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/210964
Reviewed-by: Graham Pople <[email protected]>
Tested-by: Build Bot <[email protected]>

Author: programmatix

scala-client/src/main/scala/com/couchbase/client/scala/search/vector/SearchRequest.scala

@@ -41,7 +41,6 @@ case class SearchRequest private (
     * @return a copy of this, for chaining.
     */
   @SinceCouchbase("7.6")
-  @Uncommitted
   def vectorSearch(vectorSearch: VectorSearch): SearchRequest = {
     this.vectorSearch match {
       case Some(_) =>
@@ -100,7 +99,6 @@ object SearchRequest {
     new SearchRequest(Some(searchQuery), None)
 
   /** Execute a [[VectorSearch]]. */
-  @Uncommitted
   def vectorSearch(vectorSearch: VectorSearch): SearchRequest =
     new SearchRequest(None, Some(vectorSearch))
 }

scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorQuery.scala

@@ -16,16 +16,16 @@
 
 package com.couchbase.client.scala.search.vector
 
+import com.couchbase.client.core.annotation.SinceCouchbase
 import com.couchbase.client.core.annotation.Stability.Uncommitted
 import com.couchbase.client.core.api.search.vector.{CoreVector, CoreVectorQuery}
 
 /** Represents a vector query. */
-@Uncommitted
 case class VectorQuery private (
-    private val vectorQuery: Array[Float],
+    private val vectorQuery: Either[Array[Float], String],
     private val vectorField: String,
     private val numCandidates: Option[Int] = None,
-    private val boost: Option[Double] = None
+    private val boost: Option[Double] = None,
 ) {
 
   /** Can be used to control how much weight to give the results of this query vs other queries.
@@ -46,15 +46,24 @@ case class VectorQuery private (
 
   private[scala] def toCore: CoreVectorQuery =
     new CoreVectorQuery(
-      CoreVector.eitherOf(vectorQuery, null),
+      vectorQuery match {
+        case Left(floatArray) => CoreVector.of(floatArray)
+        case Right(base64String) => CoreVector.of(base64String)
+      },
       vectorField,
       numCandidates.map(Integer.valueOf).orNull,
       boost.map(java.lang.Double.valueOf).orNull
     )
 }
 
-@Uncommitted
 object VectorQuery {
+  /** Will perform a vector query using a vector provided as an array of floats. */
+  @SinceCouchbase("7.6")
   def apply(vectorField: String, vectorQuery: Array[Float]): VectorQuery =
-    new VectorQuery(vectorQuery, vectorField)
+    new VectorQuery(Left(vectorQuery), vectorField)
+
+  /** Will perform a vector query using a vector provided as an array of floats. */
+  @SinceCouchbase("7.6.2")
+  def apply(vectorField: String, vectorQueryBase64: String): VectorQuery =
+    new VectorQuery(Right(vectorQueryBase64), vectorField)
 }

scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearch.scala

@@ -21,7 +21,6 @@ import com.couchbase.client.core.api.search.vector.CoreVectorSearch
 import scala.collection.JavaConverters._
 
 /** Allows one or more [[VectorQuery]]s to be executed. */
-@Uncommitted
 case class VectorSearch private (
     private val vectorQueries: Iterable[VectorQuery],
     private val vectorSearchOptions: Option[VectorSearchOptions] = None
@@ -41,7 +40,6 @@ case class VectorSearch private (
     )
 }
 
-@Uncommitted
 object VectorSearch {
 
   /** Create a [[VectorSearch]] containing a single [[VectorQuery]]. */

scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearchOptions.scala

@@ -16,14 +16,9 @@
 
 package com.couchbase.client.scala.search.vector
 
-import com.couchbase.client.core.annotation.Stability.Uncommitted
-import com.couchbase.client.core.api.search.vector.{
-  CoreVectorQueryCombination,
-  CoreVectorSearchOptions
-}
+import com.couchbase.client.core.api.search.vector.{CoreVectorQueryCombination, CoreVectorSearchOptions}
 
 /** Specifies how multiple [[VectorQuery]]s in a [[VectorSearch]] are combined. */
-@Uncommitted
 sealed trait VectorQueryCombination
 object VectorQueryCombination {
 
@@ -35,7 +30,6 @@ object VectorQueryCombination {
 }
 
 /** Options related to executing a [[VectorSearch]]. */
-@Uncommitted
 case class VectorSearchOptions private (
     private val vectorQueryCombination: Option[VectorQueryCombination] = None
 ) {