Engine Score Processor

This processor is in charge of calculating the engine score for a specific query. It calculates the score by comparing the set of ids from the current results with a known set of relevant document ids.

Configuration

Example configuration in a processor:

 {
  "type": "engine-score-processor"
  "name": "engine-score description",
  "kFactor": 0.9,
  "precision": 4,
  "resultIdPath": "response.hits[*].id",
  "relevantIdPath": "relevant.id",
  "resultPosPath": "result_position",
  "output": "engineScore",
  "offlineMode": false
}

Configuration parameters:

kFactor (Optional, Double) Value between 0 and 1 used to determine the importance of the relevant records showing in the first results position. Defaults to 0.9

precision (Optional, Integer) Number of digits to return after the decimal point for the score value. Defaults to 4

resultIdPath (Optional, String) The JMESpath (https://jmespath.org/) used to select the array of result document ids (from the document being processed) to be used in the engine scoring calculation. Defaults to response.hits[*].id

relevantIdPath (Optional, String) The JMESpath used to select the array of relevant document ids (from the document being processed) to be used in the engine scoring calculation. Defaults to relevant.id

relevantIdPath (Optional, String) The JMESpath used to select the metadata field containing the position of the search result to be used in the engine scoring calculation. Defaults to result_position

output (Optional, String) The output field to populate with the engine score. Defaults to engineScore

offlineMode (Optional, Boolean) When true it calculates the query score based on the 'result position' metadata field value only. Defaults to false

startPosition (Optional, int) Indicate the start position to take into account when doing the K-factor calculation. Defaults to 1

©2024 Pureinsights Technology Corporation