Merge pull request #116 from dscorbett/WS-1258

WS-1258: Expose a sentiment model type option

Author: dscorbett

json/src/main/java/com/basistech/rosette/apimodel/jackson/ApiModelMixinModule.java

@@ -57,6 +57,7 @@
 import com.basistech.rosette.apimodel.Response;
 import com.basistech.rosette.apimodel.SentenceWithDependencies;
 import com.basistech.rosette.apimodel.SentencesResponse;
+import com.basistech.rosette.apimodel.SentimentModelType;
 import com.basistech.rosette.apimodel.SentimentOptions;
 import com.basistech.rosette.apimodel.SentimentResponse;
 import com.basistech.rosette.apimodel.SyntaxDependenciesResponse;
@@ -139,8 +140,10 @@ public void setupModule(Module.SetupContext context) {
         context.setMixInAnnotations(Concept.class, ConceptMixin.class);
 
         context.setMixInAnnotations(AccuracyMode.class, AccuracyModeMixin.class);
+        context.setMixInAnnotations(SentimentModelType.class, SentimentModelTypeMixin.class);
         SimpleSerializers keySerializers = new SimpleSerializers();
         keySerializers.addSerializer(new AccuracyModeSerializer());
+        keySerializers.addSerializer(new SentimentModelTypeSerializer());
         context.addKeySerializers(keySerializers);
 
         context.setMixInAnnotations(BatchRequest.class, BatchRequestMixin.class);

json/src/main/java/com/basistech/rosette/apimodel/jackson/SentimentModelTypeDeserializer.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2017 Basis Technology Corp.
+ *
+ * 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.
+ */
+
+package com.basistech.rosette.apimodel.jackson;
+
+import com.basistech.rosette.apimodel.SentimentModelType;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+
+import java.io.IOException;
+
+/**
+ * A Jackson deserializer for {@link SentimentModelType}.
+ */
+public class SentimentModelTypeDeserializer extends StdDeserializer<SentimentModelType> {
+    public SentimentModelTypeDeserializer() {
+        super(SentimentModelType.class);
+    }
+
+    @Override
+    public SentimentModelType deserialize(final JsonParser jp, final DeserializationContext ctxt) throws IOException {
+        return SentimentModelType.forValue(jp.getText());
+    }
+}

json/src/main/java/com/basistech/rosette/apimodel/jackson/SentimentModelTypeMixin.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2017 Basis Technology Corp.
+ *
+ * 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.
+ */
+
+package com.basistech.rosette.apimodel.jackson;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
+@JsonSerialize(using = SentimentModelTypeSerializer.class, keyUsing = SentimentModelTypeSerializer.class)
+@JsonDeserialize(using = SentimentModelTypeDeserializer.class)
+public class SentimentModelTypeMixin extends BaseMixin {
+}

json/src/main/java/com/basistech/rosette/apimodel/jackson/SentimentModelTypeSerializer.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017 Basis Technology Corp.
+ *
+ * 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.
+ */
+
+package com.basistech.rosette.apimodel.jackson;
+
+import com.basistech.rosette.apimodel.SentimentModelType;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+
+import java.io.IOException;
+
+/**
+ * A Jackson serializer for {@link SentimentModelType}.
+ */
+public class SentimentModelTypeSerializer extends JsonSerializer<SentimentModelType> {
+    @Override
+    public void serialize(
+            final SentimentModelType sentimentModelType,
+            final JsonGenerator jsonGenerator,
+            final SerializerProvider serializerProvider)
+            throws IOException {
+        jsonGenerator.writeString(sentimentModelType.getLabel());
+    }
+
+    @Override
+    public Class<SentimentModelType> handledType() {
+        return SentimentModelType.class;
+    }
+}

json/src/main/java/com/basistech/rosette/apimodel/jackson/SentimentOptionsMixin.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2014 Basis Technology Corp.
+* Copyright 2017 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 package com.basistech.rosette.apimodel.jackson;
 
+import com.basistech.rosette.apimodel.SentimentModelType;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
@@ -25,7 +26,8 @@ public abstract class SentimentOptionsMixin extends OptionsMixin {
     @JsonCreator
     protected SentimentOptionsMixin(
             @JsonProperty("calculateEntityConfidence") Boolean calculateEntityConfidence,
-            @JsonProperty("calculateEntitySalience") Boolean calculateEntitySalience
+            @JsonProperty("calculateEntitySalience") Boolean calculateEntitySalience,
+            @JsonProperty("modelType") SentimentModelType modelType
     ) {
         //
     }

model/src/main/java/com/basistech/rosette/apimodel/SentimentModelType.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2017 Basis Technology Corp.
+ *
+ * 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.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import java.util.EnumSet;
+
+/**
+ * A model type for sentiment analysis.
+ */
+public enum SentimentModelType {
+    SVM("svm"),
+    DNN("dnn"),
+    /**/;
+
+    private final String label;
+
+    SentimentModelType(final String label) {
+        this.label = label;
+    }
+
+    /**
+     * Gets this model type's label.
+     * @return this model type's label
+     */
+    public String getLabel() {
+        return label;
+    }
+
+    /**
+     * Checks if a value is a valid {@code SentimentModelType}
+     * @param value an input value
+     * @return the {@code SentimentModelType} corresponding to the input value
+     * @throws IllegalArgumentException if the input string is invalid
+     */
+    public static SentimentModelType forValue(final String value) throws IllegalArgumentException {
+        for (final SentimentModelType sentimentModelType : EnumSet.allOf(SentimentModelType.class)) {
+            if (sentimentModelType.label.equalsIgnoreCase(value)) {
+                return sentimentModelType;
+            }
+        }
+        throw new IllegalArgumentException("invalid sentiment model type: " + value);
+    }
+}

model/src/main/java/com/basistech/rosette/apimodel/SentimentOptions.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2014 Basis Technology Corp.
+* Copyright 2017 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -22,18 +22,26 @@
  * Sentiment options.
  */
 public final class SentimentOptions extends Options {
-    public static final SentimentOptions DEGAULT_OPTIONS = new SentimentOptions(false, false);
+    public static final SentimentOptions DEFAULT_OPTIONS = new SentimentOptions(false, false, SentimentModelType.SVM);
     private Boolean calculateEntityConfidence;
     private Boolean calculateEntitySalience;
+    private SentimentModelType modelType;
 
     /**
-     * Constructor for {@code SentimentOptions}
-     *
-     * @param calculateEntityConfidence return confidence score for the entities.
+     * Constructs a {@code SentimentOptions}.
+     * @param calculateEntityConfidence whether to return confidence
+     *                                  scores for entities
+     * @param calculateEntitySalience whether to return salience values
+     *                                for entities
+     * @param modelType the model type
      */
-    protected SentimentOptions(Boolean calculateEntityConfidence, Boolean calculateEntitySalience) {
+    protected SentimentOptions(
+            final Boolean calculateEntityConfidence,
+            final Boolean calculateEntitySalience,
+            final SentimentModelType modelType) {
         this.calculateEntityConfidence = calculateEntityConfidence;
         this.calculateEntitySalience = calculateEntitySalience;
+        this.modelType = modelType;
     }
 
     /**
@@ -50,6 +58,14 @@ public Boolean getCalculateEntitySalience() {
         return calculateEntitySalience;
     }
 
+    /**
+     * Gets the model type.
+     * @return the model type
+     */
+    public SentimentModelType getModelType() {
+        return modelType;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -60,17 +76,19 @@ public boolean equals(Object o) {
         }
         SentimentOptions that = (SentimentOptions)o;
         return Objects.equals(this.calculateEntityConfidence, that.calculateEntityConfidence)
-                && Objects.equals(this.calculateEntitySalience, that.calculateEntitySalience);
+                && Objects.equals(this.calculateEntitySalience, that.calculateEntitySalience)
+                && modelType == that.modelType;
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(calculateEntityConfidence, calculateEntitySalience);
+        return Objects.hash(calculateEntityConfidence, calculateEntitySalience, modelType);
     }
 
     public static class Builder {
         private Boolean calculateEntityConfidence;
         private Boolean calculateEntitySalience;
+        private SentimentModelType modelType;
 
         /**
          * DocumentRequest calculate entity confidence score. If the value is {@code true}, then the endpoint will
@@ -94,8 +112,18 @@ public Builder calculateEntitySalience(Boolean calculateEntitySalience) {
             return this;
         }
 
+        /**
+         * Sets the model type for sentiment analysis.
+         * @param modelType the model type
+         * @return {@code this}
+         */
+        public Builder modelType(final SentimentModelType modelType) {
+            this.modelType = modelType;
+            return this;
+        }
+
         public SentimentOptions build() {
-            return new SentimentOptions(calculateEntityConfidence, calculateEntitySalience);
+            return new SentimentOptions(calculateEntityConfidence, calculateEntitySalience, modelType);
         }
     }
 }