feat: request all metadata with Metadata.ALL

Author: bevzzz

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

@@ -415,4 +415,49 @@ public void testBadRequest_async() throws Throwable {
       }
     }
   }
+
+  @Test
+  public void testMetadataAll() throws IOException {
+    // Arrange
+    var nsThings = ns("Things");
+    client.collections.create(nsThings,
+        c -> c
+            .properties(Property.text("name"))
+            .vectors(Vectorizers.text2vecContextionary(
+                t2v -> t2v.sourceProperties("name"))));
+
+    var things = client.collections.use(nsThings);
+    var frisbee = things.data.insert(Map.of("name", "orange disc"));
+
+    // Act
+    var gotHybrid = things.query.hybrid("orange", q -> q
+        .queryProperties("name")
+        .returnMetadata(Metadata.ALL));
+
+    var gotNearText = things.query.nearText("frisbee", q -> q
+        .returnMetadata(Metadata.ALL));
+
+    // Assert
+    var metadataHybrid = Assertions.assertThat(gotHybrid.objects())
+        .hasSize(1)
+        .extracting(WeaviateObject::metadata)
+        .first().actual();
+
+    Assertions.assertThat(metadataHybrid.uuid()).as("uuid").isNotNull().isEqualTo(frisbee.uuid());
+    Assertions.assertThat(metadataHybrid.creationTimeUnix()).as("creationTimeUnix").isNotNull();
+    Assertions.assertThat(metadataHybrid.lastUpdateTimeUnix()).as("lastUpdateTimeUnix").isNotNull();
+    Assertions.assertThat(metadataHybrid.score()).as("score").isNotNull();
+    Assertions.assertThat(metadataHybrid.explainScore()).as("explainScore").isNotNull().isNotEqualTo("");
+
+    var metadataNearText = Assertions.assertThat(gotNearText.objects())
+        .hasSize(1)
+        .extracting(WeaviateObject::metadata)
+        .first().actual();
+
+    Assertions.assertThat(metadataNearText.uuid()).as("uuid").isNotNull().isEqualTo(frisbee.uuid());
+    Assertions.assertThat(metadataNearText.creationTimeUnix()).as("creationTimeUnix").isNotNull();
+    Assertions.assertThat(metadataNearText.lastUpdateTimeUnix()).as("lastUpdateTimeUnix").isNotNull();
+    Assertions.assertThat(metadataNearText.distance()).as("distance").isNotNull();
+    Assertions.assertThat(metadataNearText.certainty()).as("certainty").isNotNull();
+  }
 }

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

@@ -11,6 +11,8 @@
 public interface Metadata {
   void appendTo(WeaviateProtoSearchGet.MetadataRequest.Builder metadata);
 
+  /** Include metadata in the metadata response. */
+  public static final Metadata ALL = MetadataField.ALL;
   /** Include associated vector in the metadata response. */
   public static final Metadata VECTOR = MetadataField.VECTOR;
   /** Include object creation time in the metadata response. */
@@ -68,6 +70,7 @@ public interface Metadata {
    * MetadataField are collection properties that can be requested for any object.
    */
   enum MetadataField implements Metadata {
+    ALL,
     UUID,
     VECTOR,
     CREATION_TIME_UNIX,
@@ -79,6 +82,12 @@ enum MetadataField implements Metadata {
 
     public void appendTo(WeaviateProtoSearchGet.MetadataRequest.Builder metadata) {
       switch (this) {
+        case ALL: // fallthrough to add all
+          for (final var f : MetadataField.values()) {
+            if (f != ALL) {
+              f.appendTo(metadata);
+            }
+          }
         case UUID:
           metadata.setUuid(true);
           break;