Skip to main content
Version: v1.4.1

Datasets

Upload, manage, and explore datasets.

All methods are accessed via client.datasets.

list_datasets()​

List all available public datasets.

Returns​

list — List of dataset names

Example​

1result = client.datasets.list_datasets()

load_dataset()​

Load a public dataset by name. Downloads the CSV directly from the xplainable public blob storage. Known datasets: telco_churn, titanic, heart_disease, iris

Parameters​

namestrRequired
Name of the dataset to load

Returns​

DataFrame — DataFrame containing the dataset

Example​

1result = client.datasets.load_dataset(
2 name="My Resource"
3)

upload_dataset()​

POST/v1/datasets/upload

Upload a dataset file.

Parameters​

file_pathstrRequired
Path to the dataset file
namestrRequired
Name for the dataset
descriptionstrdefault: None
Optional description
team_idstrdefault: None
Optional team ID (uses session team_id if not provided)

Returns​

DatasetUploadResponse — Upload response with dataset information

Example​

1result = client.datasets.upload_dataset(
2 file_path="./data.csv",
3 name="My Resource",
4 description="A description",
5 team_id="team_abc123"
6)

delete_dataset()​

DELETE/v1/datasets/{dataset_id}

Delete a dataset.

Parameters​

dataset_idstrRequired
ID of the dataset to delete

Returns​

dict — Success message

Example​

1result = client.datasets.delete_dataset(
2 dataset_id="ds_abc123"
3)

get_dataset_info()​

GET/v1/datasets/{dataset_id}

Get information about a specific dataset.

Parameters​

dataset_idstrRequired
ID of the dataset

Returns​

DatasetInfo — Dataset information

Example​

1result = client.datasets.get_dataset_info(
2 dataset_id="ds_abc123"
3)

preview_dataset()​

GET/v1/datasets/{dataset_id}/preview

Preview a dataset by returning first N rows.

Parameters​

dataset_idstrRequired
ID of the dataset
rowsintdefault: 10
Number of rows to preview

Returns​

DataFrame — DataFrame with preview data

Example​

1result = client.datasets.preview_dataset(
2 dataset_id="ds_abc123",
3 rows=10
4)

preview_dataset_json()​

GET/v1/datasets/{dataset_id}/preview

Preview a dataset as JSON records.

Parameters​

dataset_idstrRequired
ID of the dataset
rowsintdefault: 10
Number of rows to preview

Returns​

list — List of row dicts (JSON records)

Example​

1result = client.datasets.preview_dataset_json(
2 dataset_id="ds_abc123",
3 rows=10
4)

list_team_datasets()​

GET/v1/datasets/teams/{team_id}

List all datasets for a team.

Parameters​

team_idstrdefault: None
Optional team ID (uses session team_id if not provided)

Returns​

list — List of dataset information

Example​

1result = client.datasets.list_team_datasets(
2 team_id="team_abc123"
3)