Section ID:
DOC-API-MODEL-schema-1jehhpchdc#overview
DatasetRun
Metadata describing one execution of an evaluation dataset.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1jehhpchdc#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1jehhpchdc#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1jehhpchdc#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-runidSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-runidrunId | string | Optional | Identifier of the evaluation dataset run. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-datasetidSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-datasetiddatasetId | string | Optional | Identifier of the evaluation dataset. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-nameSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-namename | string | Optional | Name assigned to this execution of the evaluation dataset. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-descriptionSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-metadatajsonSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-metadatajsonmetadataJson | string | Optional | Additional attributes serialized as a JSON object. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-itemcountSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-itemcountitemCount | string (int64) | Optional | Number of dataset items reported for this run. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1jehhpchdc#field-createdatSection ID: DOC-API-MODEL-schema-1jehhpchdc#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Where used
Section ID: DOC-API-MODEL-schema-1jehhpchdc#where-used
| Reference | Relationship |
|---|---|
| Get a dataset run | POST /api/v1/evals/get-dataset-run |
| List dataset runs | POST /api/v1/evals/list-dataset-runs |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1jehhpchdc