Section ID:
Values of
DOC-API-MODEL-schema-1k2h0fdd77#overview
ScoreConfig
Score definition specifying its value type, bounds, and allowed categories.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-configidSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-configidconfigId | string | Optional | Identifier of the score configuration defining the score’s value domain. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-nameSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-namename | string | Optional | Name identifying the score definition. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-datatypeSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-datatypedataType | string (SCORE_DATA_TYPE_NUMERIC, SCORE_DATA_TYPE_CATEGORICAL, SCORE_DATA_TYPE_BOOLEAN, SCORE_DATA_TYPE_TEXT) or integer (int32) | Optional; explicit presence | Value type used to interpret numeric, categorical, Boolean, or text score values. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-descriptionSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-minvalueSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-minvalueminValue | number (double) or string (NaN, Infinity, -Infinity) | Optional | Minimum numeric score value allowed by the score configuration. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-maxvalueSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-maxvaluemaxValue | number (double) or string (NaN, Infinity, -Infinity) | Optional | Maximum numeric score value allowed by the score configuration. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-categoriesSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-categoriescategories | Array of ScoreConfigCategory | Optional | Named score categories defined by the score configuration. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-isarchivedSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-isarchivedisArchived | boolean | Optional | Whether the score configuration is archived. Archived configurations are retained so historical scores remain interpretable. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-createdatSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#field-updatedatSection ID: DOC-API-MODEL-schema-1k2h0fdd77#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of dataType
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#response-values-datatype
Scores
Data representation of an evaluation score or score configuration.
| Value | No. | Form | Meaning |
|---|---|---|---|
SCORE_DATA_TYPE_NUMERIC | 0 | Canonical | A numeric measurement or rating. |
SCORE_DATA_TYPE_CATEGORICAL | 1 | Canonical | A value chosen from a named set of categories. |
SCORE_DATA_TYPE_BOOLEAN | 2 | Canonical | A true-or-false evaluation result. |
SCORE_DATA_TYPE_TEXT | 3 | Canonical | Free-form text supplied by an evaluator or reviewer. The provider supports text values on score definitions and scores; support through this API depends on the operation. |
Where used
Section ID: DOC-API-MODEL-schema-1k2h0fdd77#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 ID: DOC-API-MODEL-schema-1k2h0fdd77