NearestNeighborsAnalyzer

Author: rashtao

src/main/java/com/arangodb/entity/arangosearch/AnalyzerType.java

@@ -37,5 +37,6 @@ public enum AnalyzerType {
     geopoint,
     segmentation,
     collation,
-    classification
+    classification,
+    nearest_neighbors
 }

src/main/java/com/arangodb/entity/arangosearch/analyzer/NearestNeighborsAnalyzer.java

@@ -0,0 +1,66 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity.arangosearch.analyzer;
+
+
+import com.arangodb.entity.arangosearch.AnalyzerType;
+
+import java.util.Objects;
+
+/**
+ * An Analyzer capable of finding nearest neighbors of tokens in the input. It applies a user-provided supervised
+ * fastText word embedding model to retrieve nearest neighbor tokens in the text. It is able to find neighbors of
+ * individual tokens as well as entire input strings. For entire input strings, the Analyzer will return nearest
+ * neighbors for each token within the input string.
+ *
+ * @author Michele Rastelli
+ * @see <a href= "https://www.arangodb.com/docs/stable/analyzers.html#nearest_neighbors">API Documentation</a>
+ * @since ArangoDB 3.10
+ */
+public class NearestNeighborsAnalyzer extends SearchAnalyzer {
+    public NearestNeighborsAnalyzer() {
+        setType(AnalyzerType.nearest_neighbors);
+    }
+
+    private NearestNeighborsAnalyzerProperties properties;
+
+    public NearestNeighborsAnalyzerProperties getProperties() {
+        return properties;
+    }
+
+    public void setProperties(NearestNeighborsAnalyzerProperties properties) {
+        this.properties = properties;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        if (!super.equals(o)) return false;
+        NearestNeighborsAnalyzer that = (NearestNeighborsAnalyzer) o;
+        return Objects.equals(properties, that.properties);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), properties);
+    }
+}

src/main/java/com/arangodb/entity/arangosearch/analyzer/NearestNeighborsAnalyzerProperties.java

@@ -0,0 +1,69 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity.arangosearch.analyzer;
+
+
+import com.arangodb.velocypack.annotations.SerializedName;
+
+import java.util.Objects;
+
+/**
+ * @author Michele Rastelli
+ * @since ArangoDB 3.10
+ */
+public class NearestNeighborsAnalyzerProperties {
+
+    @SerializedName("model_location")
+    private String modelLocation;
+
+    @SerializedName("top_k")
+    private Integer topK;
+
+
+    public String getModelLocation() {
+        return modelLocation;
+    }
+
+    public void setModelLocation(String modelLocation) {
+        this.modelLocation = modelLocation;
+    }
+
+    public Integer getTopK() {
+        return topK;
+    }
+
+    public void setTopK(Integer topK) {
+        this.topK = topK;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        NearestNeighborsAnalyzerProperties that = (NearestNeighborsAnalyzerProperties) o;
+        return Objects.equals(modelLocation, that.modelLocation) && Objects.equals(topK, that.topK);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(modelLocation, topK);
+    }
+}

src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java

@@ -104,6 +104,8 @@ public class VPackDeserializers {
                 return context.deserialize(vpack, CollationAnalyzer.class);
             case classification:
                 return context.deserialize(vpack, ClassificationAnalyzer.class);
+            case nearest_neighbors:
+                return context.deserialize(vpack, NearestNeighborsAnalyzer.class);
             default:
                 throw new IllegalArgumentException("Unknown analyzer type: " + type);
         }

src/test/java/com/arangodb/ArangoSearchTest.java

@@ -1011,6 +1011,29 @@ void classificationAnalyzer(ArangoDatabase db) {
         createGetAndDeleteTypedAnalyzer(db, analyzer);
     }
 
+    @ParameterizedTest(name = "{index}")
+    @MethodSource("dbs")
+    void nearestNeighborsAnalyzer(ArangoDatabase db) {
+        assumeTrue(isAtLeastVersion(3, 10));
+        assumeTrue(isEnterprise());
+
+        NearestNeighborsAnalyzerProperties properties = new NearestNeighborsAnalyzerProperties();
+        properties.setModelLocation("/tmp/foo.bin");
+        properties.setTopK(2);
+
+        Set<AnalyzerFeature> features = new HashSet<>();
+        features.add(AnalyzerFeature.frequency);
+        features.add(AnalyzerFeature.norm);
+        features.add(AnalyzerFeature.position);
+
+        NearestNeighborsAnalyzer analyzer = new NearestNeighborsAnalyzer();
+        analyzer.setName("test-" + UUID.randomUUID());
+        analyzer.setProperties(properties);
+        analyzer.setFeatures(features);
+
+        createGetAndDeleteTypedAnalyzer(db, analyzer);
+    }
+
     @ParameterizedTest(name = "{index}")
     @MethodSource("dbs")
     void offsetFeature(ArangoDatabase db) {