Merge pull request #59 from o19s/coec

COEC changes

opensearch-search-quality-evaluation-plugin/Dockerfile

@@ -2,5 +2,5 @@ FROM opensearchproject/opensearch:2.18.0
 
 RUN /usr/share/opensearch/bin/opensearch-plugin install --batch https://github.com/opensearch-project/user-behavior-insights/releases/download/2.18.0.2/opensearch-ubi-2.18.0.2.zip
 
-ADD ./build/distributions/search-quality-evaluation-plugin-2.18.0.0.zip  /tmp/search-quality-evaluation-plugin.zip
+ADD ./build/distributions/search-quality-evaluation-plugin-0.0.1.zip  /tmp/search-quality-evaluation-plugin.zip
 RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/search-quality-evaluation-plugin.zip

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

@@ -1,2 +1,2 @@
 opensearchVersion = 2.18.0
-evalVersion = 2.18.0.0
+evalVersion = 0.0.1

opensearch-search-quality-evaluation-plugin/scripts/get-click-through-rates.sh

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+curl -s "http://localhost:9200/click_through_rates/_search" | jq

opensearch-search-quality-evaluation-plugin/scripts/get-rank-aggregated-clickthrough.sh

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+curl -s "http://localhost:9200/rank_aggregated_ctr/_search" | jq

opensearch-search-quality-evaluation-plugin/src/main/java/org/opensearch/eval/judgments/clickmodel/coec/CoecClickModel.java

@@ -46,7 +46,6 @@
 import java.util.LinkedList;
 import java.util.Map;
 import java.util.Set;
-import java.util.UUID;
 
 public class CoecClickModel extends ClickModel {
 
@@ -346,16 +345,28 @@ public Map<Integer, Double> getRankAggregatedClickThrough() throws Exception {
 
         for(final Integer x : clickCounts.keySet()) {
 
-            if(!(impressionCounts.get(x) == null)) {
+            if(impressionCounts.get(x) != null) {
 
-                // Calculate the CTR by dividing the number of clicks by the number of impressions.
-                LOGGER.debug("Position = {}, Click Count = {}, Event Count = {}", x, clickCounts.get(x), impressionCounts.get(x));
-                rankAggregatedClickThrough.put(x, clickCounts.get(x) / impressionCounts.get(x));
+                if(clickCounts.get(x) != null) {
+
+                    // Calculate the CTR by dividing the number of clicks by the number of impressions.
+                    LOGGER.debug("Position = {}, Impression Counts = {}, Click Count = {}", x, impressionCounts.get(x), clickCounts.get(x));
+                    rankAggregatedClickThrough.put(x, clickCounts.get(x) / impressionCounts.get(x));
+
+                } else {
+
+                    // This document has impressions but no clicks so it's CTR is zero.
+                    LOGGER.debug("Position = {}, Impression Counts = {}, Click Count = {}", x, clickCounts.get(x), clickCounts.get(x));
+                    rankAggregatedClickThrough.put(x, 0.0);
+
+                }
 
             } else {
+
                 // This will happen in the case where a document has a "click" event but not an "impression." This
                 // likely should not happen, but we will protect against an NPE anyway by setting the CTR to zero.
                 rankAggregatedClickThrough.put(x, (double) 0);
+
             }
 
         }

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

@@ -267,12 +267,12 @@ public void indexClickthroughRates(final Map<String, Set<ClickthroughRate>> clic
 
             final BulkRequest request = new BulkRequest();
 
-            for(final String queryId : clickthroughRates.keySet()) {
+            for(final String userQuery : clickthroughRates.keySet()) {
 
-                for(final ClickthroughRate clickthroughRate : clickthroughRates.get(queryId)) {
+                for(final ClickthroughRate clickthroughRate : clickthroughRates.get(userQuery)) {
 
                     final Map<String, Object> jsonMap = new HashMap<>();
-                    jsonMap.put("query_id", queryId);
+                    jsonMap.put("user_query", userQuery);
                     jsonMap.put("clicks", clickthroughRate.getClicks());
                     jsonMap.put("events", clickthroughRate.getEvents());
                     jsonMap.put("ctr", clickthroughRate.getClickthroughRate());