Skip to main content
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#overview

DatasetItem

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

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-itemidSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-itemiditemIdstringOptionalIdentifier of the evaluation dataset item.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-datasetidSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-datasetiddatasetIdstringOptionalIdentifier of the evaluation dataset.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-datasetnameSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-datasetnamedatasetNamestringOptionalName of the evaluation dataset.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-inputjsonSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-inputjsoninputJsonstringOptionalEvaluation input serialized as JSON.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-expectedoutputjsonSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-expectedoutputjsonexpectedOutputJsonstringOptionalExpected output serialized as JSON. Empty until a curator supplies an expected result.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-metadatajsonSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-metadatajsonmetadataJsonstringOptionalAdditional attributes serialized as a JSON object.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-sourcetraceidSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-sourcetraceidsourceTraceIdstringOptionalIdentifier of the trace from which the dataset item originated.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-sourceobservationidSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-sourceobservationidsourceObservationIdstringOptionalIdentifier of the observation from which the dataset item originated.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-statusSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-statusstatusstring (DATASET_ITEM_STATUS_ACTIVE, DATASET_ITEM_STATUS_ARCHIVED) or integer (int32)Optional; explicit presenceState controlling whether the dataset item participates in evaluation.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-createdatSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-createdatcreatedAtstring (date-time)OptionalTime when this record was created.
Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#field-updatedatSection ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-field-updatedatupdatedAtstring (date-time)OptionalTime when this record was last updated.

Values of status​

Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#response-values-status

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

ValueNo.FormMeaning
DATASET_ITEM_STATUS_ACTIVE0CanonicalThe dataset item is active.
DATASET_ITEM_STATUS_ARCHIVED1CanonicalThe dataset item is archived and retained as historical content.

Where used​

Section ID: DOC-API-MODEL-schema-1jcdgbb5sm#where-used

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

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1jcdgbb5sm