feat: add .includeVector() shortcut like the other clients have

Author: bevzzz

src/it/java/io/weaviate/integration/DataITest.java

@@ -257,9 +257,8 @@ public void testUpdate() throws IOException {
     var updIvanhoe = books.query.byId(
         ivanhoe.metadata().uuid(),
         query -> query
-            .returnMetadata(Metadata.VECTOR)
-            .returnReferences(
-                QueryReference.single("writtenBy")));
+            .includeVector()
+            .returnReferences(QueryReference.single("writtenBy")));
 
     Assertions.assertThat(updIvanhoe).get()
         .satisfies(book -> {

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

@@ -117,6 +117,10 @@ public final SELF returnMetadata(List<Metadata> metadata) {
       return (SELF) this;
     }
 
+    public final SELF includeVector() {
+      return returnMetadata(Metadata.VECTOR);
+    }
+
     final BaseQueryOptions baseOptions() {
       return _build();
     }

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

@@ -75,6 +75,10 @@ public final Builder returnMetadata(List<Metadata> metadata) {
       return this;
     }
 
+    public final Builder includeVector() {
+      return returnMetadata(Metadata.VECTOR);
+    }
+
     @Override
     public ById build() {
       return new ById(this);

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

@@ -2,7 +2,9 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 import java.util.function.Function;
 
 import io.weaviate.client6.v1.api.collections.query.Metadata.MetadataField;
@@ -12,7 +14,6 @@
 public record QueryReference(
     String property,
     String collection,
-    boolean includeVector,
     List<String> includeVectors,
     List<String> returnProperties,
     List<QueryReference> returnReferences,
@@ -22,11 +23,10 @@ public QueryReference(Builder options) {
     this(
         options.property,
         options.collection,
-        options.includeVector,
-        options.includeVectors,
-        options.returnProperties,
+        new ArrayList<>(options.includeVectors),
+        new ArrayList<>(options.returnProperties),
         options.returnReferences,
-        options.returnMetadata);
+        new ArrayList<>(options.returnMetadata));
   }
 
   public static QueryReference single(String property) {
@@ -51,25 +51,19 @@ public static class Builder implements ObjectBuilder<QueryReference> {
     private final String property;
     private final String collection;
 
-    private boolean includeVector;
-    private List<String> includeVectors = new ArrayList<>();
-    private List<String> returnProperties = new ArrayList<>();
+    private Set<String> includeVectors = new HashSet<>();
+    private Set<String> returnProperties = new HashSet<>();
     private List<QueryReference> returnReferences = new ArrayList<>();
-    private List<Metadata> returnMetadata = new ArrayList<>();
+    private Set<Metadata> returnMetadata = new HashSet<>();
 
     public Builder(String collection, String property) {
       this.property = property;
       this.collection = collection;
       returnMetadata(MetadataField.UUID);
     }
 
-    public final Builder includeVector() {
-      this.includeVector = true;
-      return this;
-    }
-
     public final Builder includeVectors(String... vectors) {
-      this.includeVectors = Arrays.asList(vectors);
+      this.includeVectors.addAll(Arrays.asList(vectors));
       return this;
     }
 
@@ -100,6 +94,10 @@ public final Builder returnMetadata(List<Metadata> metadata) {
       return this;
     }
 
+    public final Builder includeVector() {
+      return returnMetadata(Metadata.VECTOR);
+    }
+
     @Override
     public QueryReference build() {
       return new QueryReference(this);
@@ -115,6 +113,7 @@ public void appendTo(WeaviateProtoSearchGet.RefPropertiesRequest.Builder referen
     if (!returnMetadata.isEmpty()) {
       var metadata = WeaviateProtoSearchGet.MetadataRequest.newBuilder();
       returnMetadata.forEach(m -> m.appendTo(metadata));
+      metadata.addAllVectors(includeVectors);
       references.setMetadata(metadata);
     }