Skip to main content

DatasetItem

One evaluation input with its expected output and source trace references.

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
itemIdstringOptionalIdentifier of the dataset or annotation queue item.
datasetIdstringOptionalIdentifier of the evaluation dataset.
datasetNamestringOptionalName of the evaluation dataset.
inputJsonstringOptionalEvaluation input serialized as JSON.
expectedOutputJsonstringOptionalExpected output serialized as JSON. Empty until a curator supplies an expected result.
metadataJsonstringOptionalAdditional attributes serialized as a JSON object.
sourceTraceIdstringOptionalIdentifier of the trace from which the dataset item originated.
sourceObservationIdstringOptionalIdentifier of the observation from which the dataset item originated.
statusstring (DATASET_ITEM_STATUS_ACTIVE, DATASET_ITEM_STATUS_ARCHIVED) or integer (int32)OptionalState controlling whether the dataset item participates in evaluation.
createdAtstring (date-time)OptionalTime when this record was created.
updatedAtstring (date-time)OptionalTime when this record was last updated.

Values of status​

Whether a dataset item is active or retained as archived content.

ValueNo.FormMeaning
DATASET_ITEM_STATUS_ACTIVE1CanonicalThe dataset item is active.
DATASET_ITEM_STATUS_ARCHIVED2CanonicalThe dataset item is archived and retained as historical content.

Where used​

ReferenceRelationship
List dataset itemsPOST /api/v1/evals/list-dataset-items

Download the public reference contract.

Document: DOC-API-MODEL-dataset-item.