feat: introduce target vectors to hybrid query

Author: bevzzz

src/main/java/io/weaviate/client6/v1/api/collections/query/AbstractQueryClient.java

@@ -248,6 +248,29 @@ public ResponseT hybrid(String query, Function<Hybrid.Builder, ObjectBuilder<Hyb
     return hybrid(Hybrid.of(query, fn));
   }
 
+  /**
+   * Query collection objects using hybrid search.
+   *
+   * @param searchTarget Query target.
+   * @throws WeaviateApiException in case the server returned with an
+   *                              error status code.
+   */
+  public ResponseT hybrid(Target searchTarget) {
+    return hybrid(Hybrid.of(searchTarget));
+  }
+
+  /**
+   * Query collection objects using hybrid search.
+   *
+   * @param searchTarget Query target.
+   * @param fn           Lambda expression for optional parameters.
+   * @throws WeaviateApiException in case the server returned with an
+   *                              error status code.
+   */
+  public ResponseT hybrid(Target searchTarget, Function<Hybrid.Builder, ObjectBuilder<Hybrid>> fn) {
+    return hybrid(Hybrid.of(searchTarget, fn));
+  }
+
   /**
    * Query collection objects using hybrid search.
    *
@@ -292,6 +315,40 @@ public GroupedResponseT hybrid(String query, Function<Hybrid.Builder, ObjectBuil
     return hybrid(Hybrid.of(query, fn), groupBy);
   }
 
+  /**
+   * Query collection objects using hybrid search.
+   *
+   * @param searchTarget Query target.
+   * @param groupBy      Group-by clause.
+   * @return Grouped query result.
+   * @throws WeaviateApiException in case the server returned with an
+   *                              error status code.
+   *
+   * @see GroupBy
+   * @see QueryResponseGrouped
+   */
+  public GroupedResponseT hybrid(Target searchTarget, GroupBy groupBy) {
+    return hybrid(Hybrid.of(searchTarget), groupBy);
+  }
+
+  /**
+   * Query collection objects using hybrid search.
+   *
+   * @param searchTarget Query target.
+   * @param fn           Lambda expression for optional parameters.
+   * @param groupBy      Group-by clause.
+   * @return Grouped query result.
+   * @throws WeaviateApiException in case the server returned with an
+   *                              error status code.
+   *
+   * @see GroupBy
+   * @see QueryResponseGrouped
+   */
+  public GroupedResponseT hybrid(Target searchTarget, Function<Hybrid.Builder, ObjectBuilder<Hybrid>> fn,
+      GroupBy groupBy) {
+    return hybrid(Hybrid.of(searchTarget, fn), groupBy);
+  }
+
   /**
    * Query collection objects using hybrid search.
    *

src/main/java/io/weaviate/client6/v1/api/collections/query/Hybrid.java

@@ -6,13 +6,15 @@
 import java.util.function.Function;
 
 import io.weaviate.client6.v1.api.collections.aggregate.AggregateObjectFilter;
+import io.weaviate.client6.v1.api.collections.query.Target.CombinedTextTarget;
+import io.weaviate.client6.v1.api.collections.query.Target.TextTarget;
 import io.weaviate.client6.v1.internal.ObjectBuilder;
 import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoAggregate;
 import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoBaseSearch;
 import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoSearchGet;
 
 public record Hybrid(
-    String query,
+    Target searchTarget,
     List<String> queryProperties,
     SearchOperator searchOperator,
     Float alpha,
@@ -27,16 +29,24 @@ public static enum FusionType {
   }
 
   public static final Hybrid of(String query) {
-    return of(query, ObjectBuilder.identity());
+    return of(Target.text(List.of(query)));
   }
 
   public static final Hybrid of(String query, Function<Builder, ObjectBuilder<Hybrid>> fn) {
-    return fn.apply(new Builder(query)).build();
+    return of(Target.text(List.of(query)), fn);
+  }
+
+  public static final Hybrid of(Target searchTarget) {
+    return of(searchTarget, ObjectBuilder.identity());
+  }
+
+  public static final Hybrid of(Target searchTarget, Function<Builder, ObjectBuilder<Hybrid>> fn) {
+    return fn.apply(new Builder(searchTarget)).build();
   }
 
   public Hybrid(Builder builder) {
     this(
-        builder.query,
+        builder.searchTarget,
         builder.queryProperties,
         builder.searchOperator,
         builder.alpha,
@@ -48,7 +58,7 @@ public Hybrid(Builder builder) {
 
   public static class Builder extends BaseQueryOptions.Builder<Builder, Hybrid> {
     // Required query parameters.
-    private final String query;
+    private final Target searchTarget;
 
     // Optional query parameters.
     List<String> queryProperties = new ArrayList<>();
@@ -58,8 +68,8 @@ public static class Builder extends BaseQueryOptions.Builder<Builder, Hybrid> {
     FusionType fusionType;
     Float maxVectorDistance;
 
-    public Builder(String query) {
-      this.query = query;
+    public Builder(Target searchTarget) {
+      this.searchTarget = searchTarget;
     }
 
     /** Select properties to be included in the results scoring. */
@@ -155,9 +165,14 @@ public final void appendTo(WeaviateProtoSearchGet.SearchRequest.Builder req) {
 
   private WeaviateProtoBaseSearch.Hybrid.Builder protoBuilder() {
     var hybrid = WeaviateProtoBaseSearch.Hybrid.newBuilder()
-        .setQuery(query)
         .addAllProperties(queryProperties);
 
+    if (searchTarget instanceof TextTarget text) {
+      hybrid.setQuery(text.query().get(0));
+    } else if (searchTarget instanceof CombinedTextTarget combined) {
+      hybrid.setQuery(combined.query().get(0));
+    }
+
     if (alpha != null) {
       hybrid.setAlpha(alpha);
     }
@@ -177,12 +192,17 @@ private WeaviateProtoBaseSearch.Hybrid.Builder protoBuilder() {
 
     if (near != null) {
       if (near instanceof NearVector nv) {
-        hybrid.setNearVector(nv.protoBuilder());
+        hybrid.setNearVector(nv.protoBuilder(false));
       } else if (near instanceof NearText nt) {
-        hybrid.setNearText(nt.protoBuilder());
+        hybrid.setNearText(nt.protoBuilder(false));
       }
     }
 
+    var targets = WeaviateProtoBaseSearch.Targets.newBuilder();
+    if (searchTarget.appendTargets(targets)) {
+      hybrid.setTargets(targets);
+    }
+
     return hybrid;
   }
 }

src/main/java/io/weaviate/client6/v1/api/collections/query/NearText.java

@@ -117,19 +117,19 @@ public final void appendTo(WeaviateProtoBaseSearch.NearTextSearch.Move.Builder m
   @Override
   public void appendTo(WeaviateProtoSearchGet.SearchRequest.Builder req) {
     common.appendTo(req);
-    req.setNearText(protoBuilder());
+    req.setNearText(protoBuilder(true));
   }
 
   @Override
   public void appendTo(WeaviateProtoAggregate.AggregateRequest.Builder req) {
     if (common.limit() != null) {
       req.setLimit(common.limit());
     }
-    req.setNearText(protoBuilder());
+    req.setNearText(protoBuilder(true));
   }
 
   // Package-private for Hybrid to see.
-  WeaviateProtoBaseSearch.NearTextSearch.Builder protoBuilder() {
+  WeaviateProtoBaseSearch.NearTextSearch.Builder protoBuilder(boolean withTargets) {
     var nearText = WeaviateProtoBaseSearch.NearTextSearch.newBuilder();
 
     if (searchTarget instanceof TextTarget text) {
@@ -139,7 +139,7 @@ WeaviateProtoBaseSearch.NearTextSearch.Builder protoBuilder() {
     }
 
     var targets = WeaviateProtoBaseSearch.Targets.newBuilder();
-    if (searchTarget.appendTargets(targets)) {
+    if (withTargets && searchTarget.appendTargets(targets)) {
       nearText.setTargets(targets);
     }
 

src/main/java/io/weaviate/client6/v1/api/collections/query/NearVector.java

@@ -40,24 +40,24 @@ public final NearVector build() {
   @Override
   public final void appendTo(WeaviateProtoSearchGet.SearchRequest.Builder req) {
     common.appendTo(req);
-    req.setNearVector(protoBuilder());
+    req.setNearVector(protoBuilder(true));
   }
 
   @Override
   public void appendTo(WeaviateProtoAggregate.AggregateRequest.Builder req) {
     if (common.limit() != null) {
       req.setLimit(common.limit());
     }
-    req.setNearVector(protoBuilder());
+    req.setNearVector(protoBuilder(true));
   }
 
-  // This is made package-private for Hybrid to see. Should we refactor?
-  WeaviateProtoBaseSearch.NearVector.Builder protoBuilder() {
+  WeaviateProtoBaseSearch.NearVector.Builder protoBuilder(boolean withTargets) {
     var nearVector = WeaviateProtoBaseSearch.NearVector.newBuilder();
 
     searchTarget.appendVectors(nearVector);
+
     var targets = WeaviateProtoBaseSearch.Targets.newBuilder();
-    if (searchTarget.appendTargets(targets)) {
+    if (withTargets && searchTarget.appendTargets(targets)) {
       nearVector.setTargets(targets);
     }