Data Designer's Config Builder

Use DataDesignerConfigBuilder to construct DataDesignerConfig objects. The builder accumulates model configs, tool configs, column configs, constraints, seed settings, processors, and profilers.

Inputs can come from scratch, a dict, BuilderConfig, a local YAML/JSON file, or an HTTP(S) YAML/JSON URL via from_config(). Use build() to create a DataDesignerConfig, or write_config() to serialize the current builder config to YAML or JSON.

Model config loading

DataDesignerConfigBuilder accepts model configs as a list of ModelConfig objects, a YAML/JSON config path, or None. When model_configs=None, the builder loads default model configs if Data Designer can run locally; otherwise initialization raises BuilderConfigurationError. Model configs define the aliases referenced by model-backed columns such as LLMTextColumnConfig, LLMCodeColumnConfig, LLMStructuredColumnConfig, LLMJudgeColumnConfig, EmbeddingColumnConfig, and ImageColumnConfig.

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, tool_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
tool_configs	list[ToolConfig] | None	Tool configurations for MCP tool calling. Can be: - None if no tool configs are needed - A list of ToolConfig objects	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.
add_tool_config	Add a tool configuration 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.
delete_tool_config	Delete a tool 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.
get_tool_config	Get a tool configuration by alias.
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.
tool_configs	list[ToolConfig]	Get the tool configurations for this builder.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def __init__(
    self,
    model_configs: list[ModelConfig] | str | Path | None = None,
    tool_configs: list[ToolConfig] | None = None,
):
    """Initialize a new DataDesignerConfigBuilder instance.

    Args:
        model_configs: 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
        tool_configs: Tool configurations for MCP tool calling. Can be:
            - None if no tool configs are needed
            - A list of ToolConfig objects
    """
    self._column_configs = {}
    self._model_configs = _load_model_configs(model_configs)
    self._tool_configs: list[ToolConfig] = tool_configs or []
    self._processor_configs: list[ProcessorConfigT] = []
    self._seed_config: SeedConfig | None = None
    self._constraints: list[ColumnConstraintT] = []
    self._profilers: list[ColumnProfilerConfigT] = []

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.

tool_configs property

Get the tool configurations for this builder.

Returns:

Type	Description
list[ToolConfig]	A list of ToolConfig objects used for MCP tool calling.

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 column_config is not provided.	None
column_type	DataDesignerColumnType | None	Column type to add. This is only used if column_config is not provided.	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 neither a column config nor the required constructor arguments are provided.
InvalidColumnTypeError	If the provided column config is not one of the supported column config types.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def add_column(
    self,
    column_config: ColumnConfigT | None = None,
    *,
    name: str | None = None,
    column_type: DataDesignerColumnType | None = None,
    **kwargs,
) -> Self:
    """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.

    Args:
        column_config: Data Designer column config object to add.
        name: Name of the column to add. This is only used if `column_config` is not provided.
        column_type: Column type to add. This is only used if `column_config` is not provided.
        **kwargs: Additional keyword arguments to pass to the column constructor.

    Returns:
        The current Data Designer config builder instance.

    Raises:
        BuilderConfigurationError: If neither a column config nor the required constructor
            arguments are provided.
        InvalidColumnTypeError: If the provided column config is not one of the supported
            column config types.
    """
    if column_config is None:
        if name is None or column_type is None:
            raise BuilderConfigurationError(
                "🛑 You must provide either a 'column_config' object or 'name' *and* 'column_type' "
                f"with additional keyword arguments. You provided {column_config=}, {name=}, and {column_type=}."
            )
        column_config = get_column_config_from_kwargs(name=name, column_type=column_type, **kwargs)

    allowed_column_configs = ColumnConfigT.__args__
    if not any(isinstance(column_config, t) for t in allowed_column_configs):
        raise InvalidColumnTypeError(
            f"🛑 Invalid column config object: '{column_config}'. Valid column config options are: "
            f"{', '.join([t.__name__ for t in allowed_column_configs])}"
        )

    self._column_configs[column_config.name] = column_config
    return self

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 constraint is provided.	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 packages/data-designer-config/src/data_designer/config/config_builder.py

def add_constraint(
    self,
    constraint: ColumnConstraintT | None = None,
    *,
    constraint_type: ConstraintType | None = None,
    **kwargs,
) -> Self:
    """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.

    Args:
        constraint: Constraint object to add.
        constraint_type: Constraint type to add. Ignored when `constraint` is provided.
        **kwargs: Additional keyword arguments to pass to the constraint constructor.

    Returns:
        The current Data Designer config builder instance.
    """
    if constraint is None:
        if constraint_type is None:
            raise BuilderConfigurationError(
                "🛑 You must provide either a 'constraint' object or 'constraint_type' "
                "with additional keyword arguments."
            )
        try:
            constraint_type = ConstraintType(constraint_type)
        except Exception:
            raise BuilderConfigurationError(
                f"🛑 Invalid constraint type: {constraint_type}. Valid options are: "
                f"{', '.join([t.value for t in ConstraintType])}"
            )
        if constraint_type == ConstraintType.SCALAR_INEQUALITY:
            constraint = ScalarInequalityConstraint(**kwargs)
        elif constraint_type == ConstraintType.COLUMN_INEQUALITY:
            constraint = ColumnInequalityConstraint(**kwargs)

    allowed_constraint_types = ColumnConstraintT.__args__
    if not any(isinstance(constraint, t) for t in allowed_constraint_types):
        raise BuilderConfigurationError(
            "🛑 Invalid constraint object. Valid constraint options are: "
            f"{', '.join([t.__name__ for t in allowed_constraint_types])}"
        )

    self._constraints.append(constraint)
    return self

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def add_model_config(self, model_config: ModelConfig) -> Self:
    """Add a model configuration to the current Data Designer configuration.

    Args:
        model_config: The model configuration to add.
    """
    if model_config.alias in [mc.alias for mc in self._model_configs]:
        raise BuilderConfigurationError(
            f"🛑 Model configuration with alias {model_config.alias} already exists. Please delete the existing model configuration or choose a different alias."
        )
    self._model_configs.append(model_config)
    return self

add_processor(processor_config=None, *, processor_type=None, **kwargs)

Add a processor to the current Data Designer configuration.

If a processor with the same name already exists, it is replaced (upsert), making notebook cells safely re-runnable.

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def add_processor(
    self,
    processor_config: ProcessorConfigT | None = None,
    *,
    processor_type: ProcessorType | None = None,
    **kwargs,
) -> Self:
    """Add a processor to the current Data Designer configuration.

    If a processor with the same name already exists, it is replaced (upsert),
    making notebook cells safely re-runnable.

    You can either provide a processor config object directly, or provide a processor type and
    additional keyword arguments to construct the processor config object.

    Args:
        processor_config: The processor configuration object to add.
        processor_type: The type of processor to add.
        **kwargs: Additional keyword arguments to pass to the processor constructor.

    Returns:
        The current Data Designer config builder instance.
    """
    if processor_config is None:
        if processor_type is None:
            raise BuilderConfigurationError(
                "🛑 You must provide either a 'processor_config' object or 'processor_type' "
                "with additional keyword arguments."
            )
        processor_config = get_processor_config_from_kwargs(processor_type=processor_type, **kwargs)

    self._remove_processor_by_name(processor_config.name)

    # Checks elsewhere fail if DropColumnsProcessor drops a column but it is not marked for drop
    if processor_config.processor_type == ProcessorType.DROP_COLUMNS:
        for col in self._resolve_drop_column_names(processor_config.column_names):
            self._column_configs[col].drop = True

    self._processor_configs.append(processor_config)
    return self

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def add_profiler(self, profiler_config: ColumnProfilerConfigT) -> Self:
    """Add a profiler to the current Data Designer configuration.

    Args:
        profiler_config: The profiler configuration object to add.

    Returns:
        The current Data Designer config builder instance.

    Raises:
        BuilderConfigurationError: If the profiler configuration is of an invalid type.
    """
    if not isinstance(profiler_config, ColumnProfilerConfigT):
        if hasattr(ColumnProfilerConfigT, "__args__"):
            valid_options = ", ".join([t.__name__ for t in ColumnProfilerConfigT.__args__])
        else:
            valid_options = ColumnProfilerConfigT.__name__
        raise BuilderConfigurationError(f"🛑 Invalid profiler object. Valid profiler options are: {valid_options}")
    self._profilers.append(profiler_config)
    return self

add_tool_config(tool_config)

Add a tool configuration to the current Data Designer configuration.

Parameters:

Name	Type	Description	Default
tool_config	ToolConfig	The tool configuration to add.	required

Returns:

Type	Description
Self	The current Data Designer config builder instance.

Raises:

Type	Description
BuilderConfigurationError	If a tool configuration with the same alias already exists.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def add_tool_config(self, tool_config: ToolConfig) -> Self:
    """Add a tool configuration to the current Data Designer configuration.

    Args:
        tool_config: The tool configuration to add.

    Returns:
        The current Data Designer config builder instance.

    Raises:
        BuilderConfigurationError: If a tool configuration with the same alias already exists.
    """
    if tool_config.tool_alias in {tc.tool_alias for tc in self._tool_configs}:
        raise BuilderConfigurationError(
            f"Tool configuration with alias {tool_config.tool_alias} already exists. "
            "Please delete the existing tool configuration or choose a different alias."
        )
    self._tool_configs.append(tool_config)
    return self

build()

Build a DataDesignerConfig instance based on the current builder configuration.

Returns:

Type	Description
DataDesignerConfig	The current Data Designer config object.

Raises:

Type	Description
BuilderConfigurationError	If any ToolConfig has duplicate tool names in its allow_tools list.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def build(self) -> DataDesignerConfig:
    """Build a DataDesignerConfig instance based on the current builder configuration.

    Returns:
        The current Data Designer config object.

    Raises:
        BuilderConfigurationError: If any ToolConfig has duplicate tool names in its allow_tools list.
    """
    self._validate_tool_configs_no_duplicates()
    return DataDesignerConfig(
        model_configs=self._model_configs,
        tool_configs=self._tool_configs,
        seed_config=self._seed_config,
        columns=list(self._column_configs.values()),
        constraints=self._constraints or None,
        profilers=self._profilers or None,
        processors=self._processor_configs or None,
    )

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def delete_column(self, column_name: str) -> Self:
    """Delete the column with the given name.

    Args:
        column_name: Name of the column to delete.

    Returns:
        The current Data Designer config builder instance.

    Raises:
        BuilderConfigurationError: If trying to delete a seed dataset column.
    """
    if isinstance(self._column_configs.get(column_name), SeedDatasetColumnConfig):
        raise BuilderConfigurationError("Seed columns cannot be deleted. Please update the seed dataset instead.")
    self._column_configs.pop(column_name, None)
    return self

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def delete_constraints(self, target_column: str) -> Self:
    """Delete all constraints for the given target column.

    Args:
        target_column: Name of the column to remove constraints for.

    Returns:
        The current Data Designer config builder instance.
    """
    self._constraints = [c for c in self._constraints if c.target_column != target_column]
    return self

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def delete_model_config(self, alias: str) -> Self:
    """Delete a model configuration from the current Data Designer configuration by alias.

    Args:
        alias: The alias of the model configuration to delete.
    """
    self._model_configs = [mc for mc in self._model_configs if mc.alias != alias]
    if len(self._model_configs) == 0:
        logger.warning(
            f"⚠️ No model configurations found after deleting model configuration with alias {alias}. Please add a model configuration before building the configuration."
        )
    return self

delete_tool_config(alias)

Delete a tool configuration from the current Data Designer configuration by alias.

Parameters:

Name	Type	Description	Default
alias	str	The alias of the tool configuration to delete.	required

Returns:

Type	Description
Self	The current Data Designer config builder instance.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def delete_tool_config(self, alias: str) -> Self:
    """Delete a tool configuration from the current Data Designer configuration by alias.

    Args:
        alias: The alias of the tool configuration to delete.

    Returns:
        The current Data Designer config builder instance.
    """
    self._tool_configs = [tc for tc in self._tool_configs if tc.tool_alias != alias]
    return self

from_config(config) classmethod

Create a DataDesignerConfigBuilder from an existing configuration.

Accepts both the full BuilderConfig format (with a top-level data_designer key) and the shorthand DataDesignerConfig format (columns, model_configs, etc. at the top level). When the shorthand format is detected it is automatically normalized into a full BuilderConfig.

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 local YAML/JSON configuration file - An HTTP(S) URL string 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 packages/data-designer-config/src/data_designer/config/config_builder.py

@classmethod
def from_config(cls, config: dict | str | Path | BuilderConfig) -> Self:
    """Create a DataDesignerConfigBuilder from an existing configuration.

    Accepts both the full ``BuilderConfig`` format (with a top-level
    ``data_designer`` key) and the shorthand ``DataDesignerConfig`` format
    (``columns``, ``model_configs``, etc. at the top level). When the
    shorthand format is detected it is automatically normalized into a
    full ``BuilderConfig``.

    Args:
        config: Configuration source. Can be:
            - A dictionary containing the configuration
            - A string or Path to a local YAML/JSON configuration file
            - An HTTP(S) URL string to a YAML/JSON configuration file
            - A BuilderConfig object

    Returns:
        A new instance populated with the configuration from the provided source.

    Raises:
        ValueError: If the config format is invalid.
        ValidationError: If the builder config loaded from the config is invalid.
    """
    if isinstance(config, BuilderConfig):
        builder_config = config
    else:
        json_config = json.loads(serialize_data(smart_load_yaml(config)))
        # Normalize shorthand DataDesignerConfig into full BuilderConfig
        if "columns" in json_config and "data_designer" not in json_config:
            json_config = {"data_designer": json_config}
        builder_config = BuilderConfig.model_validate(json_config)

    builder = cls(
        model_configs=builder_config.data_designer.model_configs,
        tool_configs=builder_config.data_designer.tool_configs,
    )
    data_designer_config = builder_config.data_designer

    for col in data_designer_config.columns:
        builder.add_column(col)

    for constraint in data_designer_config.constraints or []:
        builder.add_constraint(constraint=constraint)

    if (seed_config := data_designer_config.seed_config) is not None:
        builder.with_seed_dataset(
            seed_config.source,
            sampling_strategy=seed_config.sampling_strategy,
            selection_strategy=seed_config.selection_strategy,
        )

    return builder

get_builder_config()

Get the builder config for the current Data Designer configuration.

Returns:

Type	Description
BuilderConfig	The builder config.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def get_builder_config(self) -> BuilderConfig:
    """Get the builder config for the current Data Designer configuration.

    Returns:
        The builder config.
    """
    return BuilderConfig(data_designer=self.build())

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def get_column_config(self, name: str) -> ColumnConfigT:
    """Get a column configuration by name.

    Args:
        name: Name of the column to retrieve the config for.

    Returns:
        The column configuration object.

    Raises:
        KeyError: If no column with the given name exists.
    """
    return self._column_configs[name]

get_column_configs()

Get all column configurations.

Returns:

Type	Description
list[ColumnConfigT]	A list of all column configuration objects.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def get_column_configs(self) -> list[ColumnConfigT]:
    """Get all column configurations.

    Returns:
        A list of all column configuration objects.
    """
    return list(self._column_configs.values())

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def get_columns_excluding_type(self, column_type: DataDesignerColumnType) -> list[ColumnConfigT]:
    """Get all column configurations excluding the specified type.

    Args:
        column_type: The type of columns to exclude.

    Returns:
        A list of column configurations that do not match the specified type.
    """
    column_type = resolve_string_enum(column_type, DataDesignerColumnType)
    return [c for c in self._column_configs.values() if c.column_type != column_type]

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def get_columns_of_type(self, column_type: DataDesignerColumnType) -> list[ColumnConfigT]:
    """Get all column configurations of the specified type.

    Args:
        column_type: The type of columns to filter by.

    Returns:
        A list of column configurations matching the specified type.
    """
    column_type = resolve_string_enum(column_type, DataDesignerColumnType)
    return [c for c in self._column_configs.values() if c.column_type == column_type]

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def get_constraints(self, target_column: str) -> list[ColumnConstraintT]:
    """Get all constraints for the given target column.

    Args:
        target_column: Name of the column to get constraints for.

    Returns:
        A list of constraint objects targeting the specified column.
    """
    return [c for c in self._constraints if c.target_column == target_column]

get_processor_configs()

Get processor configuration objects.

Returns:

Type	Description
list[ProcessorConfigT]	A list of processor configuration objects.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def get_processor_configs(self) -> list[ProcessorConfigT]:
    """Get processor configuration objects.

    Returns:
        A list of processor configuration objects.
    """
    return self._processor_configs

get_profilers()

Get all profilers.

Returns:

Type	Description
list[ColumnProfilerConfigT]	A list of profiler configuration objects.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def get_profilers(self) -> list[ColumnProfilerConfigT]:
    """Get all profilers.

    Returns:
        A list of profiler configuration objects.
    """
    return self._profilers

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def get_seed_config(self) -> SeedConfig | None:
    """Get the seed config for the current Data Designer configuration.

    Returns:
        The seed config if configured, None otherwise.
    """
    return self._seed_config

get_tool_config(alias)

Get a tool configuration by alias.

Parameters:

Name	Type	Description	Default
alias	str	The alias of the tool configuration to retrieve.	required

Returns:

Type	Description
ToolConfig	The tool configuration object.

Raises:

Type	Description
KeyError	If no tool configuration with the given alias exists.

Source code in packages/data-designer-config/src/data_designer/config/config_builder.py

def get_tool_config(self, alias: str) -> ToolConfig:
    """Get a tool configuration by alias.

    Args:
        alias: The alias of the tool configuration to retrieve.

    Returns:
        The tool configuration object.

    Raises:
        KeyError: If no tool configuration with the given alias exists.
    """
    for tc in self._tool_configs:
        if tc.tool_alias == alias:
            return tc
    raise KeyError(f"No tool configuration with alias {alias!r} found")

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def num_columns_of_type(self, column_type: DataDesignerColumnType) -> int:
    """Get the count of columns of the specified type.

    Args:
        column_type: The type of columns to count.

    Returns:
        The number of columns matching the specified type.
    """
    return len(self.get_columns_of_type(column_type))

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def with_seed_dataset(
    self,
    seed_source: SeedSourceT,
    *,
    sampling_strategy: SamplingStrategy = SamplingStrategy.ORDERED,
    selection_strategy: IndexRange | PartitionBlock | None = None,
) -> Self:
    """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.

    Args:
        seed_source: The pointer to the seed dataset.
        sampling_strategy: The sampling strategy to use when generating data from the seed dataset.
            Defaults to ORDERED sampling.
        selection_strategy: An optional selection strategy to use when generating data from the seed dataset.
            Defaults to None.

    Returns:
        The current Data Designer config builder instance.
    """
    self._seed_config = SeedConfig(
        source=seed_source,
        sampling_strategy=sampling_strategy,
        selection_strategy=selection_strategy,
    )
    return self

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 packages/data-designer-config/src/data_designer/config/config_builder.py

def write_config(self, path: str | Path, indent: int | None = 2, **kwargs) -> None:
    """Write the current configuration to a file.

    Args:
        path: Path to the file to write the configuration to.
        indent: Indentation level for the output file (default: 2).
        **kwargs: Additional keyword arguments passed to the serialization methods used.

    Raises:
        BuilderConfigurationError: If the file format is unsupported.
        BuilderSerializationError: If the configuration cannot be serialized.
    """
    if (seed_config := self.get_seed_config()) is not None and isinstance(seed_config.source, DataFrameSeedSource):
        raise BuilderSerializationError(
            "This builder was configured with a DataFrame seed dataset. "
            "DataFrame seeds cannot be serialized to config files. "
            "To serialize this configuration, change your seed dataset to a more persistent, serializable source format. "
            "For example, you could make a local file seed source from the dataframe:\n\n"
            "LocalFileSeedSource.from_dataframe(my_dataframe, '/path/to/data.parquet')"
        )

    cfg = self.get_builder_config()
    suffix = Path(path).suffix
    if suffix in {".yaml", ".yml"}:
        cfg.to_yaml(path, indent=indent, **kwargs)
    elif suffix == ".json":
        cfg.to_json(path, indent=indent, **kwargs)
    else:
        raise BuilderConfigurationError(f"🛑 Unsupported file type: {suffix}. Must be `.yaml`, `.yml` or `.json`.")