Skip to main content

Datasets

Choose your language:

Datasets provide scenarios used to evaluate a system.

client.datasets.generate(systemId, options)

Start asynchronous dataset generation for a system.

SDKclient.datasets.generate(system_id, options=None, idempotency_key=None)
ReturnsJobRef

Parameters:

LocationParameterTypeRequiredDefaultDescription
Pathsystem_idstringRequiredSystem UUID.
Bodyscenario_countintegerOptional10Number of scenarios to generate. Minimum 1, maximum 500.
Bodyuser_dataset_pathstringOptionalOptional path/reference to a user-provided dataset source.
SDK optionidempotency_keystringOptionalSent as the Idempotency-Key header.

client.datasets.import(...)

Import dataset scenarios directly. Python uses import_ because import is a reserved keyword.

SDKclient.datasets.import_(system_id, scenarios, config=None)
ReturnsDataset

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.
Bodyscenarioslist[dict]RequiredAt least one scenario. Each scenario requires input.
BodyconfigdictOptionalDataset-level metadata/configuration.

Dataset scenario fields:

FieldTypeRequiredDescription
inputstring or objectyesPrompt/input sent to the system.
expected_outputsstring[]noExpected response hints or labels.
sourcestringnoScenario source.
test_categorystringnoScenario category.
tested_aspectstringnoAspect being tested.

client.datasets.get(systemId)

Read the current dataset for a system.

SDKclient.datasets.get(system_id)
ReturnsDataset | null

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.

client.datasets.update(systemId, patch)

Patch the dataset scenarios and/or dataset config.

SDKclient.datasets.update(system_id, patch)
ReturnsDataset

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.
Bodyscenarioslist[dict]OptionalReplacement scenario list.
BodyconfigdictOptionalDataset config patch.

If scenarios is omitted and config is provided, the backend merges config into the existing dataset metadata config.

client.datasets.validate(systemId)

Validate the current dataset for a system.

SDKclient.datasets.validate(system_id)
ReturnsDataset

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.