Skip to content

Interface Errors

Interface errors represent failures surfaced at the public API boundary. DataDesignerGenerationError wraps dataset generation failures from create() and preview(), DataDesignerEarlyShutdownError identifies generation runs that terminate early without producing records, and DataDesignerProfilingError wraps profiling failures from those methods. These errors inherit from data_designer.errors.DataDesignerError, allowing callers to catch either specific interface failures or the project-wide base error type.

The package-level data_designer.interface export lazily exposes DataDesignerGenerationError, DataDesignerEarlyShutdownError, and DataDesignerProfilingError. InvalidBufferValueError is defined in this module.

DataDesignerGenerationError

Bases: DataDesignerError

Raised for errors related to a Data Designer dataset generation.

DataDesignerEarlyShutdownError

Bases: DataDesignerGenerationError

Raised when a run terminated via early shutdown and produced no records.

Subclass of DataDesignerGenerationError so existing handlers still catch it; callers that want to distinguish the early-shutdown case (e.g. to retry with a different model alias or surface a degraded-provider message to the user) can catch this specific type.

DataDesignerProfilingError

Bases: DataDesignerError

Raised for errors related to a Data Designer dataset profiling.

InvalidBufferValueError

Bases: DataDesignerError

Raised for errors related to an invalid buffer value.