DOC-API-MODEL-schema-qbff0c5l2f#overview
DatasetRunItem
One item of a dataset run links the dataset item that was executed to the trace it produced. Keeping this pairing lets you compare the same dataset item across runs.
Type-reference view: API Schema 6vk7rqoi5v. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#request-field-datasetitemiddatasetItemId | string | Required in requests | Identifier of the dataset item used by this evaluation run. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#request-field-traceidtraceId | string | Required in requests | Identifier of the evaluation trace. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#request-field-observationidobservationId | string | Optional | Optional: pin the run to one observation inside the trace rather than the whole turn, for a harness that scores a single generation. |
Request validation
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
datasetItemId | Minimum length | 1 |
traceId | Minimum length | 1 |
In responses
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#field-datasetitemidSection ID: DOC-API-MODEL-schema-qbff0c5l2f#response-field-datasetitemiddatasetItemId | string | Required in requests | Identifier of the dataset item used by this evaluation run. |
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#field-traceidSection ID: DOC-API-MODEL-schema-qbff0c5l2f#response-field-traceidtraceId | string | Required in requests | Identifier of the evaluation trace. |
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#field-observationidSection ID: DOC-API-MODEL-schema-qbff0c5l2f#response-field-observationidobservationId | string | Optional | Optional: pin the run to one observation inside the trace rather than the whole turn, for a harness that scores a single generation. |
DOC-API-MODEL-schema-qbff0c5l2f#validation
Request validation
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
datasetItemId | Minimum length | 1 |
traceId | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-qbff0c5l2f#where-used
| Reference | Relationship |
|---|---|
| DatasetRunItem | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-qbff0c5l2f