Ratings CSV

Rating parameters support the import and export of rating configuration files from the user interface in a fixed CSV format as specified below.

The HTTP API can additionally be used to read or update rating parameter configuration in JSON format.

Example ratings.csv

"2019-05-14T00:00:00.000Z","table",0:0,1:10,2:20
"2020-09-25T13:30:00.000Z","table",0.1:15,0.7:32.44,1.22:122.91,1.5:200
"2020-10-10T00:00:00.000Z","polynomial",a:1.1,b:2.5,c:1.115,d:4.01,e:0.85

Rating CSV line specification

Every line in the ratings.csv file defines a single rating. The file can contain multiple lines/ratings. Columns (separated by comma ‘,’) must use this strict format.

Column Example Description
1 “2020-09-25T13:30:00.000Z” ISO8601 start timestamp this rating applies. Note the double quotes around the timestamp.
2 “table” Rating type: [“table”, “polynomial”] Note the double quotes around the text.
3+ 0.1:15 Table: Columns 3 onwards represent the rows in the rating table. Each column must use the format <input>:<result> which contains an input lookup value and result value separated by ‘:’. In the example shown 0.1 is the input lookup value and 15 is the result.

a:1.1 Polynomial: Columns 3 onwards specifies the coefficients of a polynomial equation. Each column must use the format <coefficient>:<value>. The coefficient must be a single letter, ordered alphabetically. In the example shown a is the coefficient and 1.1 is its value.

Note

Rating configuration files require the ‘.csv’ file extension for import.

PDF HTML Epub Powered by Read The Docs