Add new SimpleKnnRealFeatureFiltered QueryBuilder

Author: yabsp

src/main/java/org/polypheny/simpleclient/scenario/vectorbench/queryBuilder/SimpleKnnRealFeatureFiltered.java

@@ -0,0 +1,120 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019-2026 The Polypheny Project
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.polypheny.simpleclient.scenario.vectorbench.queryBuilder;
+
+import kong.unirest.core.HttpRequest;
+import org.apache.commons.lang3.tuple.ImmutablePair;
+import org.polypheny.simpleclient.query.Query;
+import org.polypheny.simpleclient.query.QueryBuilder;
+import java.util.Arrays;
+import java.util.Map;
+import java.util.Random;
+
+public class SimpleKnnRealFeatureFiltered extends QueryBuilder {
+
+    private static final boolean EXPECT_RESULT = true;
+    private final int dimension;
+    private final int limit;
+    private final String norm;
+    private final Random random;
+    private final String filterCategory;
+
+    public SimpleKnnRealFeatureFiltered( long randomSeed, int dimension, int limit, String norm, String filterCategory ) {
+        this.dimension = dimension;
+        this.limit = limit;
+        this.norm = norm;
+        this.filterCategory = filterCategory;
+        this.random = new Random( randomSeed );
+    }
+
+    private Float[] getRandomVector() {
+        Float[] floats = new Float[this.dimension];
+        for ( int i = 0; i < this.dimension; i++ ) {
+            floats[i] = random.nextInt( 100 ) / 100.0f;
+        }
+        return floats;
+    }
+
+    @Override
+    public synchronized Query getNewQuery() {
+        return new SimpleKnnRealFeatureFilteredQuery( getRandomVector(), limit, norm, filterCategory );
+    }
+
+    private static class SimpleKnnRealFeatureFilteredQuery extends Query {
+
+        private final Float[] target;
+        private final int limit;
+        private final String norm;
+        private final String category;
+
+        public SimpleKnnRealFeatureFilteredQuery( Float[] target, int limit, String norm, String category ) {
+            super( EXPECT_RESULT );
+            this.target = target;
+            this.limit = limit;
+            this.norm = norm;
+            this.category = category;
+        }
+
+        @Override
+        public String getSql() {
+            return "SELECT id, distance(feature, ARRAY" + Arrays.toString(
+                    target ) + ", '" + norm + "') as dist " +
+                    "FROM knn_realfeature " +
+                    "WHERE category = '" + category + "' " +
+                    "ORDER BY dist ASC LIMIT " + limit;
+        }
+
+        @Override
+        public String getParameterizedSqlQuery() { return null; }
+
+        @Override
+        public Map<Integer, ImmutablePair<DataTypes, Object>> getParameterValues() {
+            return Map.of();
+        }
+
+
+        @Override
+        public HttpRequest<?> getRest() {
+            return null;
+        }
+
+
+        // Note: This query will currently not enable pushdown, therefore runtime is expected to be high.
+        @Override
+        public String getMongoQl() {
+            return "db.knn_realfeature.aggregate([{" +
+                    "    \"$vectorSearch\": {" +
+                    "        \"path\": \"feature\"," +
+                    "        \"queryVector\": " + Arrays.toString( target )
+                    + "," +
+                    "        \"metric\": \"" + norm + "\"," +
+                    "        \"limit\": " + limit + "," +
+                    "        \"filter\": { \"category\": \"" + category +
+                    "\" }" +
+                    "    }" +
+                    "}])";
+        }
+    }
+}