Skip to content

Datasets

Curate collections of datapoints used as test sets for evaluations and experiments.

list

Get datasets

Retrieve datasets, optionally filtered by dataset ID or name.

Usage

sh
honeyhive datasets list [options]

Options

FlagTypeRequiredDescription
--dataset-idstringnoUnique dataset ID for filtering specific dataset
--namestringnoDataset name to filter by

create

Create a dataset

Create a new dataset with an optional name, description, and initial set of datapoint IDs.

Usage

sh
honeyhive datasets create [options]

Options

FlagTypeRequiredDescription
--datapointsjsonnoInitial datapoint IDs to include
--descriptionstringnoDescription of the dataset
--namestringnoName of the dataset

update

Update a dataset

Update a dataset's name, description, or list of datapoint IDs.

Usage

sh
honeyhive datasets update [options]

Options

FlagTypeRequiredDescription
--dataset-idstringyesThe unique identifier of the dataset to update like 663876ec4611c47f4970f0c3
--datapointsjsonnoUpdated list of datapoint IDs
--descriptionstringnoNew dataset description
--namestringnoNew dataset name

delete

Delete a dataset

Permanently delete a dataset by its unique identifier.

Usage

sh
honeyhive datasets delete [options]

Options

FlagTypeRequiredDescription
--dataset-idstringyesThe unique identifier of the dataset to be deleted like 663876ec4611c47f4970f0c3

add-datapoints

Add datapoints to a dataset

Add new datapoints to an existing dataset. Provide raw data objects and a field mapping that specifies which fields map to inputs, ground truth, and history.

Usage

sh
honeyhive datasets add-datapoints [options]

Options

FlagTypeRequiredDescription
--datajsonyesArray of datapoint data objects to add
--dataset-idstringyesThe unique identifier of the dataset to add datapoints to like 663876ec4611c47f4970f0c3
--mappingjsonyesmapping

remove-datapoint

Remove a datapoint from a dataset

Remove a specific datapoint from a dataset. The datapoint itself is not deleted, only dereferenced from the dataset.

Usage

sh
honeyhive datasets remove-datapoint [options]

Options

FlagTypeRequiredDescription
--datapoint-idstringyesThe unique identifier of the datapoint to remove
--dataset-idstringyesThe unique identifier of the dataset