Basic Documents — Composite Fields
A field that is computed using only the values of other fields, rather than by
applying an algorithm to the underlying document, is called a composite field.
There are only two such fields returned by the Bilby Quant API:
policy_impact_score and policy_impact_percentage.
| Field Name | Type | Example/Possible Values | Description |
|---|---|---|---|
policy_impact_score | number | 0 ≤ value ≤ 1 | A score designed to capturethe overall impact of the policy discussed in the underlying document. |
policy_impact_percentage | number | 0 ≤ value ≤ 100 | A rescaled version of the policy_impact_score, ranging between 0 and 100. |
policy_impact_score
Definition: A weighted combination of the policy_stage_prediction,
importance_prediction, and sentiment_extremity fields, designed to capture
the overall impact of the policy discussed in the underlying document.
Possible values: A float in the interval [0, 1] (i.e., between 0 and 1,
inclusive).
policy_impact_percentage
Definition: A simple rescaling of the policy_impact_score field, computed
by the formula:
policy_impact_percentage := 100 * policy_impact_score.
Possible values: A float in the interval [0, 100] (i.e., between 0 and
100, inclusive).