Overview
Theupdate() method allows you to modify an existing dataset after it has been created.
Parameters
New dataset name. Must be a non-empty string; leading and trailing whitespace are trimmed server-side.
Arbitrary JSON-serializable metadata for tracking purposes. Replaces the existing metadata wholesale. Pass
None to clear.The full list of Specifications the dataset links to. It replaces the current links: a specification left out of the list is unlinked, and
[] removes every link. Each specification must belong to the dataset’s product and generate the dataset’s type. To add or remove links without sending the full list, use Link Datasets and Unlink Datasets.Returns
Returns the updatedDataset object.
Example
Use Cases
Replacing Metadata
Overwrite the metadata object on an existing dataset:Updating Name and Metadata Together
Replacing the Linked Specifications
Notes
All fields except
dataset_id default to PydanticUndefined (from pydantic_core).
Omit a field (or pass PydanticUndefined) to leave it unchanged.
Pass None to explicitly clear an optional field (specification_ids takes [] instead).
Pass a value to update it.Related Methods
- Create Dataset - Create a new dataset
- Get Dataset - Retrieve a dataset by ID
- List Datasets - List datasets for a product
- Delete Dataset - Soft-delete a dataset
- Link Datasets - Attach an existing dataset to a specification
- Unlink Datasets - Detach a dataset from a specification