ClassificationAnalyzer

Author: rashtao

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

@@ -24,5 +24,18 @@
  * @author Michele Rastelli
  */
 public enum AnalyzerType {
-    identity, delimiter, stem, norm, ngram, text, pipeline, stopwords, aql, geojson, geopoint, segmentation, collation
+    identity,
+    delimiter,
+    stem,
+    norm,
+    ngram,
+    text,
+    pipeline,
+    stopwords,
+    aql,
+    geojson,
+    geopoint,
+    segmentation,
+    collation,
+    classification
 }

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

@@ -0,0 +1,64 @@
+/*
+ * 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 classifying tokens in the input text. It applies a user-provided supervised fastText word
+ * embedding model to classify the input text. It is able to classify individual tokens as well as entire inputs.
+ *
+ * @author Michele Rastelli
+ * @see <a href= "https://www.arangodb.com/docs/stable/analyzers.html#classification">API Documentation</a>
+ * @since ArangoDB 3.10
+ */
+public class ClassificationAnalyzer extends SearchAnalyzer {
+    public ClassificationAnalyzer() {
+        setType(AnalyzerType.classification);
+    }
+
+    private ClassificationAnalyzerProperties properties;
+
+    public ClassificationAnalyzerProperties getProperties() {
+        return properties;
+    }
+
+    public void setProperties(ClassificationAnalyzerProperties 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;
+        ClassificationAnalyzer that = (ClassificationAnalyzer) 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/ClassificationAnalyzerProperties.java

@@ -0,0 +1,78 @@
+/*
+ * 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 ClassificationAnalyzerProperties {
+
+    @SerializedName("model_location")
+    private String modelLocation;
+
+    @SerializedName("top_k")
+    private Integer topK;
+
+    private Double threshold;
+
+    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;
+    }
+
+    public Double getThreshold() {
+        return threshold;
+    }
+
+    public void setThreshold(Double threshold) {
+        this.threshold = threshold;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        ClassificationAnalyzerProperties that = (ClassificationAnalyzerProperties) o;
+        return Objects.equals(modelLocation, that.modelLocation) && Objects.equals(topK, that.topK) && Objects.equals(threshold, that.threshold);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(modelLocation, topK, threshold);
+    }
+}

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

@@ -987,6 +987,30 @@ void collationAnalyzer(ArangoDatabase db) {
         createGetAndDeleteTypedAnalyzer(db, collationAnalyzer);
     }
 
+    @ParameterizedTest(name = "{index}")
+    @MethodSource("dbs")
+    void classificationAnalyzer(ArangoDatabase db) {
+        assumeTrue(isAtLeastVersion(3, 10));
+        assumeTrue(isEnterprise());
+
+        ClassificationAnalyzerProperties properties = new ClassificationAnalyzerProperties();
+        properties.setModelLocation("/foo/bar");
+        properties.setTopK(2);
+        properties.setThreshold(.5);
+
+        Set<AnalyzerFeature> features = new HashSet<>();
+        features.add(AnalyzerFeature.frequency);
+        features.add(AnalyzerFeature.norm);
+        features.add(AnalyzerFeature.position);
+
+        ClassificationAnalyzer analyzer = new ClassificationAnalyzer();
+        analyzer.setName("test-" + UUID.randomUUID());
+        analyzer.setProperties(properties);
+        analyzer.setFeatures(features);
+
+        createGetAndDeleteTypedAnalyzer(db, analyzer);
+    }
+
     @ParameterizedTest(name = "{index}")
     @MethodSource("dbs")
     void offsetFeature(ArangoDatabase db) {