Merge branch 'metrics' of github.com:o19s/opensearch-search-quality-e…

…valuation into metrics

opensearch-search-quality-evaluation-plugin/build.gradle

@@ -57,7 +57,6 @@ dependencies {
     compileOnly "org.apache.httpcomponents:httpcore:${versions.httpcore}"
     compileOnly "org.apache.httpcomponents:httpclient:${versions.httpclient}"
     compileOnly "commons-logging:commons-logging:${versions.commonslogging}"
-    implementation "org.apache.commons:commons-lang3:3.17.0"
     implementation "com.google.code.gson:gson:2.11.0"
     yamlRestTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
 }

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/SearchQualityEvaluationJobRunner.java

@@ -8,7 +8,6 @@
  */
 package org.opensearch.eval;
 
-import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.action.index.IndexRequest;
@@ -113,7 +112,7 @@ public void runJob(final ScheduledJobParameter jobParameter, final JobExecutionC
                     final long startTime = System.currentTimeMillis();
                     final long judgments;
 
-                    if(StringUtils.equalsIgnoreCase(searchQualityEvaluationJobParameter.getClickModel(), "coec")) {
+                    if("coec".equalsIgnoreCase(searchQualityEvaluationJobParameter.getClickModel())) {
 
                         LOGGER.info("Beginning implicit judgment generation using clicks-over-expected-clicks.");
                         final CoecClickModelParameters coecClickModelParameters = new CoecClickModelParameters(true, searchQualityEvaluationJobParameter.getMaxRank());

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/SearchQualityEvaluationRestHandler.java

@@ -35,6 +35,7 @@
 import org.opensearch.rest.RestResponse;
 
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.time.Instant;
 import java.time.temporal.ChronoUnit;
 import java.util.HashMap;
@@ -174,7 +175,7 @@ protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient cli
             }
 
             // Get the query JSON from the content.
-            final String query = new String(BytesReference.toBytes(request.content()));
+            final String query = new String(BytesReference.toBytes(request.content()), Charset.defaultCharset());
 
             // Validate the query has a QUERY_PLACEHOLDER.
             if(!query.contains(QUERY_PLACEHOLDER)) {

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/judgments/model/ClickthroughRate.java

@@ -8,7 +8,6 @@
  */
 package org.opensearch.eval.judgments.model;
 
-import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.opensearch.eval.judgments.util.MathUtils;
 
 /**
@@ -42,18 +41,6 @@ public ClickthroughRate(final String objectId, final int clicks, final int event
         this.events = events;
     }
 
-    @Override
-    public boolean equals(Object obj) {
-        return EqualsBuilder.reflectionEquals(this, obj);
-    }
-
-    @Override
-    public int hashCode() {
-        int result = 17;
-        result = 29 * result + objectId.hashCode();
-        return result;
-    }
-
     @Override
     public String toString() {
         return "object_id: " + objectId + ", clicks: "  + clicks + ", events: " + events + ", ctr: " + MathUtils.round(getClickthroughRate());

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/judgments/model/Judgment.java

@@ -8,8 +8,6 @@
  */
 package org.opensearch.eval.judgments.model;
 
-import org.apache.commons.lang3.builder.EqualsBuilder;
-import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.opensearch.eval.judgments.util.MathUtils;
@@ -106,21 +104,6 @@ public String toString() {
         return "query_id: " + queryId + ", query: " + query + ", document: " + document + ", judgment: " + MathUtils.round(judgment);
     }
 
-    @Override
-    public boolean equals(Object obj) {
-        return EqualsBuilder.reflectionEquals(this, obj);
-    }
-
-    @Override
-    public int hashCode() {
-        return new HashCodeBuilder(17, 37).
-                append(queryId).
-                append(query).
-                append(document).
-                append(judgment).
-                toHashCode();
-    }
-
     /**
      * Gets the judgment's query ID.
      * @return The judgment's query ID.

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/judgments/model/ubi/query/UbiQuery.java

@@ -9,8 +9,6 @@
 package org.opensearch.eval.judgments.model.ubi.query;
 
 import com.google.gson.annotations.SerializedName;
-import org.apache.commons.lang3.builder.EqualsBuilder;
-import org.apache.commons.lang3.builder.HashCodeBuilder;
 
 import java.util.Map;
 
@@ -47,20 +45,6 @@ public UbiQuery() {
 
     }
 
-    @Override
-    public boolean equals(Object obj) {
-        return EqualsBuilder.reflectionEquals(this, obj);
-    }
-
-    @Override
-    public int hashCode() {
-        return new HashCodeBuilder(17, 37).
-                append(queryId).
-                append(userQuery).
-                append(clientId).
-                toHashCode();
-    }
-
     /**
      * Gets the timestamp for the query.
      * @return The timestamp for the query.

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/metrics/PrecisionSearchMetric.java

@@ -40,8 +40,15 @@ public String getName() {
     @Override
     public double calculate() {
 
-        // TODO: Implement precision calculation.
-        return 0.0;
+        int numberOfRelevantItems = 0;
+
+        for(final double relevanceScore : relevanceScores) {
+            if(relevanceScore >= threshold) {
+                numberOfRelevantItems++;
+            }
+        }
+
+        return (double) numberOfRelevantItems / (double) k;
 
     }
 

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/metrics/SearchMetric.java

@@ -53,8 +53,8 @@ public int getK() {
     /**
      * Gets the value of the metric. If the metric has not yet been calculated,
      * the metric will first be calculated by calling <code>calculate</code>. This
-     * function should be used in cases where repeated access to the metric's value is
-     * needed without recalculating the metric's value.
+     * function should be used in cases where repeated access to the metrics value is
+     * needed without recalculating the metrics value.
      * @return The value of the metric.
      */
     public double getValue() {

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/runners/AbstractQuerySetRunner.java

@@ -82,7 +82,7 @@ public final Collection<Map<String, Long>> getQuerySet(final String querySetId)
         // TODO: Don't use .get()
         final SearchResponse searchResponse = client.search(searchRequest).get();
 
-        if (searchResponse.getHits().getHits().length > 0) {
+        if(searchResponse.getHits().getHits().length > 0) {
 
             // The queries from the query set that will be run.
             return (Collection<Map<String, Long>>) searchResponse.getHits().getAt(0).getSourceAsMap().get("queries");