delete_dataset¶
Operation¶
delete_dataset
async
¶
delete_dataset(input: DeleteDatasetInput, plugins: list[Plugin] | None = None) -> DeleteDatasetOutput
Deletes a dataset version or an entire dataset asynchronously. If
datasetVersion is absent, deletes all versions and the dataset record
itself. If provided, deletes only that specific version.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteDatasetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteDatasetOutput
|
An instance of |
Input¶
DeleteDatasetInput
dataclass
¶
Dataclass for DeleteDatasetInput structure.
Attributes¶
dataset_id
class-attribute
instance-attribute
¶
dataset_id: str | None = None
The unique identifier of the dataset to delete.
dataset_version
class-attribute
instance-attribute
¶
dataset_version: str | None = None
Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.
Output¶
DeleteDatasetOutput
dataclass
¶
Dataclass for DeleteDatasetOutput structure.
Attributes¶
status
instance-attribute
¶
status: DatasetStatus
The current status of the dataset after the delete request.