ScoreConfig
Score definition specifying its value type, bounds, and allowed categories.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
configId | string | Optional | Identifier of the score configuration defining the score’s value domain. |
name | string | Optional | Name identifying the score definition. |
dataType | string (SCORE_DATA_TYPE_NUMERIC, SCORE_DATA_TYPE_CATEGORICAL, SCORE_DATA_TYPE_BOOLEAN, SCORE_DATA_TYPE_TEXT) or integer (int32) | Optional | Score value type used to interpret the numeric, categorical, or boolean value. |
description | string | Optional | Human-readable description of the resource. |
minValue | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum numeric score value allowed by the score configuration. |
maxValue | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum numeric score value allowed by the score configuration. |
categories | Array of ScoreConfigCategory | Optional | Named score categories defined by the score configuration. |
isArchived | boolean | Optional | Whether the score configuration is archived. Archived configurations are retained so historical scores remain interpretable. |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of dataType
Data representation of an evaluation score or score configuration.
| Value | No. | Form | Meaning |
|---|---|---|---|
SCORE_DATA_TYPE_NUMERIC | 1 | Canonical | A numeric measurement or rating. |
SCORE_DATA_TYPE_CATEGORICAL | 2 | Canonical | A value chosen from a named set of categories. |
SCORE_DATA_TYPE_BOOLEAN | 3 | Canonical | A true-or-false evaluation result. |
SCORE_DATA_TYPE_TEXT | 4 | Canonical | Free-form text supplied by an evaluator or reviewer. |
Where used
| Reference | Relationship |
|---|---|
| List score configs | POST /api/v1/evals/list-score-configs |
| Update a score config | POST /api/v1/evals/update-score-config |
Download the public reference contract.
Document: DOC-API-MODEL-score-config.