Skip to main content
You are reading the docs of Galtea 5.17. Read this page in the latest version.

Overview

The update() method allows you to modify an existing dataset after it has been created.
Only name, metadata and specification_ids are mutable post-creation. All other fields (type, variants, strategies, uri, ground_truth_uri, data_catalog_uri, source_test_id, max_test_cases, etc.) are fixed for the lifetime of the dataset because they drive generation, credit accounting, and the stored test-case shape. Sending any of them in an update returns a 400.

Parameters

string
required
The ID of the dataset to update.
Deprecated alias: test_id.
string
New dataset name. Must be a non-empty string; leading and trailing whitespace are trimmed server-side.
Any
Arbitrary JSON-serializable metadata for tracking purposes. Replaces the existing metadata wholesale. Pass None to clear.
list[string]
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 updated Dataset 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.