Merge pull request #52 from o19s/impression

Changes view to impression
o19s · Dec 9, 2024 · 6498693 · 6498693
2 parents c8643c9 + 3b6be95
commit 6498693
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/...on-plugin/src/main/java/org/opensearch/eval/judgments/clickmodel/coec/CoecClickModel.java b/...on-plugin/src/main/java/org/opensearch/eval/judgments/clickmodel/coec/CoecClickModel.java
@@ -56,8 +56,7 @@ public class CoecClickModel extends ClickModel {
 
     // UBI event names.
     public static final String EVENT_CLICK = "click";
-    // TODO: Change "view" to "impression".
-    public static final String EVENT_VIEW = "view";
+    public static final String EVENT_IMPRESSION = "impression";
 
     private final CoecClickModelParameters parameters;
 
@@ -192,7 +191,7 @@ private Map<String, Set<ClickthroughRate>> getClickthroughRate(final int maxRank
          *                     },
          *                     {
          *                       "term": {
-         *                         "action_name": "view"
+         *                         "action_name": "impression"
          *                       }
          *                     }
          *                   ],
@@ -219,7 +218,7 @@ private Map<String, Set<ClickthroughRate>> getClickthroughRate(final int maxRank
                 "                    },\n" +
                 "                    {\n" +
                 "                      \"term\": {\n" +
-                "                        \"action_name\": \"view\"\n" +
+                "                        \"action_name\": \"impression\"\n" +
                 "                      }\n" +
                 "                    }\n" +
                 "                  ],\n" +
@@ -355,8 +354,8 @@ public Map<Integer, Double> getRankAggregatedClickThrough() throws Exception {
 
             }
 
-            // Handle the "view" bucket.
-            if(EVENT_VIEW.equalsIgnoreCase(actionBucket.getKey().toString())) {
+            // Handle the "impression" bucket.
+            if(EVENT_IMPRESSION.equalsIgnoreCase(actionBucket.getKey().toString())) {
 
                 final Terms positionTerms = actionBucket.getAggregations().get("By_Position");
                 final Collection<? extends Terms.Bucket> positionBuckets = positionTerms.getBuckets();

diff --git a/...ation-plugin/src/main/java/org/opensearch/eval/judgments/opensearch/OpenSearchHelper.java b/...ation-plugin/src/main/java/org/opensearch/eval/judgments/opensearch/OpenSearchHelper.java
@@ -145,7 +145,7 @@ public long getCountOfQueriesForUserQueryHavingResultInRankR(final String userQu
         // Get all query IDs matching this user query.
         final Collection<String> queryIds = getQueryIdsHavingUserQuery(userQuery);
 
-        // For each query ID, get the events with action_name = "view" having a match on objectId and rank (position).
+        // For each query ID, get the events with action_name = "impression" having a match on objectId and rank (position).
         for(final String queryId : queryIds) {
 
             //LOGGER.info("userQuery = {}; queryId = {}; objectId = {}; rank = {}", userQuery, queryId, objectId, rank);
@@ -160,7 +160,7 @@ public long getCountOfQueriesForUserQueryHavingResultInRankR(final String userQu
                     "          },\n" +
                     "          {\n" +
                     "            \"term\": {\n" +
-                    "              \"action_name\": \"view\"\n" +
+                    "              \"action_name\": \"impression\"\n" +
                     "            }\n" +
                     "          },\n" +
                     "          {\n" +
@@ -204,7 +204,10 @@ public long getCountOfQueriesForUserQueryHavingResultInRankR(final String userQu
 
             //LOGGER.info("Query ID: {} --- Count of {} having {} at rank {} = {}", queryId, userQuery, objectId, rank, response.getHits().getTotalHits().value);
 
-            countOfTimesShownAtRank += response.getHits().getTotalHits().value;
+            // Won't be null as long as trackTotalHits is true.
+            if(response.getHits().getTotalHits() != null) {
+                countOfTimesShownAtRank += response.getHits().getTotalHits().value;
+            }
 
         }
 

diff --git a/...y-evaluation-plugin/src/main/java/org/opensearch/eval/runners/AbstractQuerySetRunner.java b/...y-evaluation-plugin/src/main/java/org/opensearch/eval/runners/AbstractQuerySetRunner.java
@@ -92,7 +92,7 @@ public final Collection<Map<String, Long>> getQuerySet(final String querySetId)
             LOGGER.error("Unable to get query set with ID {}", querySetId);
 
             // The query set was not found.
-           throw new RuntimeException("The query set with ID " + querySetId + " was not found.");
+            throw new RuntimeException("The query set with ID " + querySetId + " was not found.");
 
         }