Data Designer's Config Builder
The config_builder module provides a high-level interface for constructing Data Designer configurations through the DataDesignerConfigBuilder class, enabling programmatic creation of DataDesignerConfig objects by incrementally adding column configurations, constraints, processors, and profilers.
You can use the builder to create Data Designer configurations from scratch or from existing configurations stored in YAML/JSON files via from_config(). The builder includes validation capabilities to catch configuration errors early and can work with seed datasets from local sources or external datastores. Once configured, use build() to generate the final configuration object or write_config() to serialize it to disk.
Model configs are required
DataDesignerConfigBuilder requires a list of model configurations at initialization. This tells the builder which model aliases can be referenced by LLM-generated columns (such as LLMTextColumnConfig, LLMCodeColumnConfig, LLMStructuredColumnConfig, and LLMJudgeColumnConfig). Each model configuration specifies the model alias, model provider, model ID, and inference parameters that will be used during data generation.
Classes:
| Name | Description |
|---|---|
BuilderConfig |
Configuration container for Data Designer builder. |
DataDesignerConfigBuilder |
Config builder for Data Designer configurations. |
BuilderConfig
Bases: ExportableConfigBase
Configuration container for Data Designer builder.
This class holds the main Data Designer configuration along with optional datastore settings needed for seed dataset operations.
Attributes:
| Name | Type | Description |
|---|---|---|
data_designer |
DataDesignerConfig
|
The main Data Designer configuration containing columns, constraints, profilers, and other settings. |
DataDesignerConfigBuilder(model_configs=None)
Config builder for Data Designer configurations.
This class provides a high-level interface for building Data Designer configurations.
Initialize a new DataDesignerConfigBuilder instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_configs
|
list[ModelConfig] | str | Path | None
|
Model configurations. Can be: - None to use default model configurations in local mode - A list of ModelConfig objects - A string or Path to a model configuration file |
None
|
Methods:
| Name | Description |
|---|---|
add_column |
Add a Data Designer column configuration to the current Data Designer configuration. |
add_constraint |
Add a constraint to the current Data Designer configuration. |
add_model_config |
Add a model configuration to the current Data Designer configuration. |
add_processor |
Add a processor to the current Data Designer configuration. |
add_profiler |
Add a profiler to the current Data Designer configuration. |
build |
Build a DataDesignerConfig instance based on the current builder configuration. |
delete_column |
Delete the column with the given name. |
delete_constraints |
Delete all constraints for the given target column. |
delete_model_config |
Delete a model configuration from the current Data Designer configuration by alias. |
from_config |
Create a DataDesignerConfigBuilder from an existing configuration. |
get_builder_config |
Get the builder config for the current Data Designer configuration. |
get_column_config |
Get a column configuration by name. |
get_column_configs |
Get all column configurations. |
get_columns_excluding_type |
Get all column configurations excluding the specified type. |
get_columns_of_type |
Get all column configurations of the specified type. |
get_constraints |
Get all constraints for the given target column. |
get_processor_configs |
Get processor configuration objects. |
get_profilers |
Get all profilers. |
get_seed_config |
Get the seed config for the current Data Designer configuration. |
num_columns_of_type |
Get the count of columns of the specified type. |
with_seed_dataset |
Add a seed dataset to the current Data Designer configuration. |
write_config |
Write the current configuration to a file. |
Attributes:
| Name | Type | Description |
|---|---|---|
allowed_references |
list[str]
|
Get all referenceable variables allowed in prompt templates and expressions. |
info |
ConfigBuilderInfo
|
Get the ConfigBuilderInfo object for this builder. |
model_configs |
list[ModelConfig]
|
Get the model configurations for this builder. |
Source code in src/data_designer/config/config_builder.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | |
allowed_references
property
Get all referenceable variables allowed in prompt templates and expressions.
This includes all column names and their side effect columns that can be referenced in prompt templates and expressions within the configuration.
Returns:
| Type | Description |
|---|---|
list[str]
|
A list of variable names that can be referenced in templates and expressions. |
info
property
Get the ConfigBuilderInfo object for this builder.
Returns:
| Type | Description |
|---|---|
ConfigBuilderInfo
|
An object containing information about the configuration. |
model_configs
property
Get the model configurations for this builder.
Returns:
| Type | Description |
|---|---|
list[ModelConfig]
|
A list of ModelConfig objects used for data generation. |
add_column(column_config=None, *, name=None, column_type=None, **kwargs)
Add a Data Designer column configuration to the current Data Designer configuration.
If no column config object is provided, you must provide the name, column_type, and any
additional keyword arguments that are required by the column config constructor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
column_config
|
ColumnConfigT | None
|
Data Designer column config object to add. |
None
|
name
|
str | None
|
Name of the column to add. This is only used if |
None
|
column_type
|
DataDesignerColumnType | None
|
Column type to add. This is only used if |
None
|
**kwargs
|
Additional keyword arguments to pass to the column constructor. |
{}
|
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Raises:
| Type | Description |
|---|---|
BuilderConfigurationError
|
If the column name collides with an existing seed dataset column. |
Source code in src/data_designer/config/config_builder.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | |
add_constraint(constraint=None, *, constraint_type=None, **kwargs)
Add a constraint to the current Data Designer configuration.
Currently, constraints are only supported for numerical samplers.
You can either provide a constraint object directly, or provide a constraint type and additional keyword arguments to construct the constraint object. Valid constraint types are: - "scalar_inequality": Constraint between a column and a scalar value. - "column_inequality": Constraint between two columns.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
constraint
|
ColumnConstraintT | None
|
Constraint object to add. |
None
|
constraint_type
|
ConstraintType | None
|
Constraint type to add. Ignored when |
None
|
**kwargs
|
Additional keyword arguments to pass to the constraint constructor. |
{}
|
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Source code in src/data_designer/config/config_builder.py
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | |
add_model_config(model_config)
Add a model configuration to the current Data Designer configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_config
|
ModelConfig
|
The model configuration to add. |
required |
Source code in src/data_designer/config/config_builder.py
161 162 163 164 165 166 167 168 169 170 171 172 | |
add_processor(processor_config=None, *, processor_type=None, **kwargs)
Add a processor to the current Data Designer configuration.
You can either provide a processor config object directly, or provide a processor type and additional keyword arguments to construct the processor config object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
processor_config
|
ProcessorConfigT | None
|
The processor configuration object to add. |
None
|
processor_type
|
ProcessorType | None
|
The type of processor to add. |
None
|
**kwargs
|
Additional keyword arguments to pass to the processor constructor. |
{}
|
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Source code in src/data_designer/config/config_builder.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | |
add_profiler(profiler_config)
Add a profiler to the current Data Designer configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
profiler_config
|
ColumnProfilerConfigT
|
The profiler configuration object to add. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Raises:
| Type | Description |
|---|---|
BuilderConfigurationError
|
If the profiler configuration is of an invalid type. |
Source code in src/data_designer/config/config_builder.py
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 | |
build()
Build a DataDesignerConfig instance based on the current builder configuration.
Returns:
| Type | Description |
|---|---|
DataDesignerConfig
|
The current Data Designer config object. |
Source code in src/data_designer/config/config_builder.py
348 349 350 351 352 353 354 355 356 357 358 359 360 361 | |
delete_column(column_name)
Delete the column with the given name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
column_name
|
str
|
Name of the column to delete. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Raises:
| Type | Description |
|---|---|
BuilderConfigurationError
|
If trying to delete a seed dataset column. |
Source code in src/data_designer/config/config_builder.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | |
delete_constraints(target_column)
Delete all constraints for the given target column.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_column
|
str
|
Name of the column to remove constraints for. |
required |
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Source code in src/data_designer/config/config_builder.py
363 364 365 366 367 368 369 370 371 372 373 | |
delete_model_config(alias)
Delete a model configuration from the current Data Designer configuration by alias.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
alias
|
str
|
The alias of the model configuration to delete. |
required |
Source code in src/data_designer/config/config_builder.py
174 175 176 177 178 179 180 181 182 183 184 185 | |
from_config(config)
classmethod
Create a DataDesignerConfigBuilder from an existing configuration.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
dict | str | Path | BuilderConfig
|
Configuration source. Can be: - A dictionary containing the configuration - A string or Path to a YAML/JSON configuration file - A BuilderConfig object |
required |
Returns:
| Type | Description |
|---|---|
Self
|
A new instance populated with the configuration from the provided source. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the config format is invalid. |
ValidationError
|
If the builder config loaded from the config is invalid. |
Source code in src/data_designer/config/config_builder.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | |
get_builder_config()
Get the builder config for the current Data Designer configuration.
Returns:
| Type | Description |
|---|---|
BuilderConfig
|
The builder config. |
Source code in src/data_designer/config/config_builder.py
535 536 537 538 539 540 541 | |
get_column_config(name)
Get a column configuration by name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the column to retrieve the config for. |
required |
Returns:
| Type | Description |
|---|---|
ColumnConfigT
|
The column configuration object. |
Raises:
| Type | Description |
|---|---|
KeyError
|
If no column with the given name exists. |
Source code in src/data_designer/config/config_builder.py
392 393 394 395 396 397 398 399 400 401 402 403 404 | |
get_column_configs()
Get all column configurations.
Returns:
| Type | Description |
|---|---|
list[ColumnConfigT]
|
A list of all column configuration objects. |
Source code in src/data_designer/config/config_builder.py
406 407 408 409 410 411 412 | |
get_columns_excluding_type(column_type)
Get all column configurations excluding the specified type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
column_type
|
DataDesignerColumnType
|
The type of columns to exclude. |
required |
Returns:
| Type | Description |
|---|---|
list[ColumnConfigT]
|
A list of column configurations that do not match the specified type. |
Source code in src/data_designer/config/config_builder.py
437 438 439 440 441 442 443 444 445 446 447 | |
get_columns_of_type(column_type)
Get all column configurations of the specified type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
column_type
|
DataDesignerColumnType
|
The type of columns to filter by. |
required |
Returns:
| Type | Description |
|---|---|
list[ColumnConfigT]
|
A list of column configurations matching the specified type. |
Source code in src/data_designer/config/config_builder.py
425 426 427 428 429 430 431 432 433 434 435 | |
get_constraints(target_column)
Get all constraints for the given target column.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_column
|
str
|
Name of the column to get constraints for. |
required |
Returns:
| Type | Description |
|---|---|
list[ColumnConstraintT]
|
A list of constraint objects targeting the specified column. |
Source code in src/data_designer/config/config_builder.py
414 415 416 417 418 419 420 421 422 423 | |
get_processor_configs()
Get processor configuration objects.
Returns:
| Type | Description |
|---|---|
dict[BuildStage, list[ProcessorConfigT]]
|
A dictionary of processor configuration objects by dataset builder stage. |
Source code in src/data_designer/config/config_builder.py
449 450 451 452 453 454 455 | |
get_profilers()
Get all profilers.
Returns:
| Type | Description |
|---|---|
list[ColumnProfilerConfigT]
|
A list of profiler configuration objects. |
Source code in src/data_designer/config/config_builder.py
340 341 342 343 344 345 346 | |
get_seed_config()
Get the seed config for the current Data Designer configuration.
Returns:
| Type | Description |
|---|---|
SeedConfig | None
|
The seed config if configured, None otherwise. |
Source code in src/data_designer/config/config_builder.py
457 458 459 460 461 462 463 | |
num_columns_of_type(column_type)
Get the count of columns of the specified type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
column_type
|
DataDesignerColumnType
|
The type of columns to count. |
required |
Returns:
| Type | Description |
|---|---|
int
|
The number of columns matching the specified type. |
Source code in src/data_designer/config/config_builder.py
465 466 467 468 469 470 471 472 473 474 | |
with_seed_dataset(seed_source, *, sampling_strategy=SamplingStrategy.ORDERED, selection_strategy=None)
Add a seed dataset to the current Data Designer configuration.
This method sets the seed dataset for the configuration, but columns are not resolved until compilation (including validation) is performed by the engine using a SeedReader.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
seed_source
|
SeedSourceT
|
The pointer to the seed dataset. |
required |
sampling_strategy
|
SamplingStrategy
|
The sampling strategy to use when generating data from the seed dataset. Defaults to ORDERED sampling. |
ORDERED
|
selection_strategy
|
IndexRange | PartitionBlock | None
|
An optional selection strategy to use when generating data from the seed dataset. Defaults to None. |
None
|
Returns:
| Type | Description |
|---|---|
Self
|
The current Data Designer config builder instance. |
Source code in src/data_designer/config/config_builder.py
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | |
write_config(path, indent=2, **kwargs)
Write the current configuration to a file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
Path to the file to write the configuration to. |
required |
indent
|
int | None
|
Indentation level for the output file (default: 2). |
2
|
**kwargs
|
Additional keyword arguments passed to the serialization methods used. |
{}
|
Raises:
| Type | Description |
|---|---|
BuilderConfigurationError
|
If the file format is unsupported. |
BuilderSerializationError
|
If the configuration cannot be serialized. |
Source code in src/data_designer/config/config_builder.py
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | |