Rank feature - unknown field linear

Signed-off-by: Yevhen Tienkaiev <[email protected]>

Author: Hronom

client/rest-high-level/src/test/java/org/opensearch/client/documentation/QueryDSLDocumentationTests.java

@@ -493,4 +493,10 @@ public void testRankFeatureSigmoid() {
             0.6f
         );
     }
+
+    public void testRankFeatureLinear() {
+        RankFeatureQueryBuilders.linear(
+            "pagerank"
+        );
+    }
 }

modules/mapper-extras/src/main/java/org/opensearch/index/query/RankFeatureQueryBuilder.java

@@ -39,6 +39,7 @@
 import org.opensearch.common.io.stream.StreamInput;
 import org.opensearch.common.io.stream.StreamOutput;
 import org.opensearch.common.xcontent.ConstructingObjectParser;
+import org.opensearch.common.xcontent.ObjectParser;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.index.mapper.RankFeatureFieldMapper.RankFeatureFieldType;
 import org.opensearch.index.mapper.RankFeatureMetaFieldMapper;
@@ -257,6 +258,51 @@ Query toQuery(String field, String feature, boolean positiveScoreImpact) throws
                 return FeatureField.newSigmoidQuery(field, feature, DEFAULT_BOOST, pivot, exp);
             }
         }
+
+        /**
+         * A scoring function that scores documents as simply {@code S}
+         * where S is the indexed value of the static feature.
+         */
+        public static class Linear extends ScoreFunction {
+
+            private static final ObjectParser<Linear, Void> PARSER = new ObjectParser<>("linear", Linear::new);
+
+            public Linear() {
+            }
+
+            private Linear(StreamInput in) {
+                this();
+            }
+
+            @Override
+            public boolean equals(Object obj) {
+                if (obj == null || getClass() != obj.getClass()) {
+                    return false;
+                }
+                return true;
+            }
+
+            @Override
+            public int hashCode() {
+                return getClass().hashCode();
+            }
+
+            @Override
+            void writeTo(StreamOutput out) throws IOException {
+                out.writeByte((byte) 3);
+            }
+
+            @Override
+            void doXContent(XContentBuilder builder) throws IOException {
+                builder.startObject("linear");
+                builder.endObject();
+            }
+
+            @Override
+            Query toQuery(String field, String feature, boolean positiveScoreImpact) throws IOException {
+                return FeatureField.newLinearQuery(field, feature, DEFAULT_BOOST);
+            }
+        }
     }
 
     private static ScoreFunction readScoreFunction(StreamInput in) throws IOException {
@@ -268,6 +314,8 @@ private static ScoreFunction readScoreFunction(StreamInput in) throws IOExceptio
             return new ScoreFunction.Saturation(in);
         case 2:
             return new ScoreFunction.Sigmoid(in);
+        case 3:
+            return new ScoreFunction.Linear(in);
         default:
             throw new IOException("Illegal score function id: " + b);
         }
@@ -305,6 +353,8 @@ private static ScoreFunction readScoreFunction(StreamInput in) throws IOExceptio
                 ScoreFunction.Saturation.PARSER, new ParseField("saturation"));
         PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(),
                 ScoreFunction.Sigmoid.PARSER, new ParseField("sigmoid"));
+        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(),
+            ScoreFunction.Linear.PARSER, new ParseField("linear"));
     }
 
     public static final String NAME = "rank_feature";

modules/mapper-extras/src/main/java/org/opensearch/index/query/RankFeatureQueryBuilders.java

@@ -77,4 +77,13 @@ public static RankFeatureQueryBuilder sigmoid(String fieldName, float pivot, flo
         return new RankFeatureQueryBuilder(fieldName, new RankFeatureQueryBuilder.ScoreFunction.Sigmoid(pivot, exp));
     }
 
+    /**
+     * Return a new {@link RankFeatureQueryBuilder} that will score documents as
+     * {@code S)} where S is the indexed value of the static feature.
+     * @param fieldName     field that stores features
+     */
+    public static RankFeatureQueryBuilder linear(String fieldName) {
+        return new RankFeatureQueryBuilder(fieldName, new RankFeatureQueryBuilder.ScoreFunction.Linear());
+    }
+
 }

modules/mapper-extras/src/test/java/org/opensearch/index/query/RankFeatureQueryBuilderTests.java

@@ -73,7 +73,7 @@ protected Collection<Class<? extends Plugin>> getPlugins() {
     protected RankFeatureQueryBuilder doCreateTestQueryBuilder() {
         ScoreFunction function;
         boolean mayUseNegativeField = true;
-        switch (random().nextInt(3)) {
+        switch (random().nextInt(4)) {
         case 0:
             mayUseNegativeField = false;
             function = new ScoreFunction.Log(1 + randomFloat());
@@ -88,6 +88,9 @@ protected RankFeatureQueryBuilder doCreateTestQueryBuilder() {
         case 2:
             function = new ScoreFunction.Sigmoid(randomFloat(), randomFloat());
             break;
+        case 3:
+            function = new ScoreFunction.Linear();
+            break;
         default:
             throw new AssertionError();
         }